Add Manual to docs #116
Add Manual to docs #116
Conversation
steinbro
left a comment
steinbro
left a comment
There was a problem hiding this comment.
Thanks for this! Since this is documentation rather than code, I'm going to pass this to @jchudge to see how this fits with existing documentation that may exist outside of this repository.
I'm wondering, who is the target audience for this manual? If it's for users, it could use more detail, though (as you documented) there are already considerable in-app tutorials. If it's for potential code contributors, I like having the outline of functionality that's otherwise missing from the repo.
docs/Manual.md
Outdated
|
|
||
| #### Places Nearby | ||
| - ```Places Nearby``` has 2 subsections: ```All Places``` and ```Public Transit```. Each of these finds the respective areas and returns them as a list. Users are able to set filters to narrow down the locations they are searching for. | ||
| - The only filters available are ```All Places``` and ```Public Transit```. |
There was a problem hiding this comment.
There are additional filters as of the latest release.
| - The Youtube Channel | ||
|
|
||
| ##### Telemetry | ||
| - Gives the user the option to stop sharing their Soundscape usage data |
There was a problem hiding this comment.
Note that this doesn't currently have any effect, as no usage data is collected either way.
4 participants
Adds Manual.md, providing detailed instructions on how to operate the Soundscape App and access its features. This includes the basic features as well as how markers and routes work as well as more.