Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make explanatory documentation #18

Open
tomcontileslie opened this issue Sep 5, 2020 · 0 comments
Open

Make explanatory documentation #18

tomcontileslie opened this issue Sep 5, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@tomcontileslie
Copy link
Owner

So that other users can contribute more effectively, we should create some explanatory documents showing - perhaps in the form of a flowchart - the full process of handling a chord request.

This could include a description of the broad thatchord -> settings -> interpret -> find -> rank -> output workflow, as well as more in-depth discussion of the finder algorithm, which is perhaps the least self-explanatory at first glance.

@tomcontileslie tomcontileslie added the documentation Improvements or additions to documentation label Sep 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant