ECHOES-from-the-Past / mei-analyser

Search and analyse Early Music chants
https://echoes-from-the-past.github.io/mei-analyser/
MIT License
2 stars 0 forks source link

Create documentation for users #39

Open martha-thomae opened 1 month ago

martha-thomae commented 1 month ago

We have talked with Elsa and we think it is time to come up with some documentation for the users. A new place on the wiki just for users would be great!

We are thinking to include an information icon on each category that requires some explanation (e.g., mode, ornamental neumes, melodic density, and melodic search). When the user clicks on this information icon, very basic information will be provided to them, together with a link to the wiki to find more information on that specific topic.

The wiki should have its own section for users documentation, divided on individual sections for each of the parts of the interface:

This should be documentation more on the way of using the interface (rather than implementation details that are relevant to the developer sections). A quick summary of how things are calculated in its current state can be provided at the end of each of these sections, but the main point is how to use the interface.

Thank you!

notkaramel commented 1 month ago

@martha-thomae I've written up a quick guide on the Project Wiki # Quick Guide, can you take a look?