Skip to content

Add Manual to docs#116

Open
kchiu1 wants to merge 6 commits into
soundscape-community:mainfrom
kchiu1:Manual
Open

Add Manual to docs#116
kchiu1 wants to merge 6 commits into
soundscape-community:mainfrom
kchiu1:Manual

Conversation

@kchiu1

@kchiu1 kchiu1 commented Oct 18, 2024

Copy link
Copy Markdown

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.

@steinbro steinbro left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread 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```.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are additional filters as of the latest release.

Comment thread docs/Manual.md
- The Youtube Channel

##### Telemetry
- Gives the user the option to stop sharing their Soundscape usage data

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that this doesn't currently have any effect, as no usage data is collected either way.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants