MitchellAcoustics / MitchellAcoustics/Soundscapy
Improve docs site organisation and explanations
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 59
- Forks
- 12
- PR merge metrics
- No merged PRs in 30d
Description
What would you like to see?
The docs are poorly organised and missing context for new users. We need to do better about onboarding new users, laying out what features and functionality are present, how soundscapy is organised, and where to find more information.
Why would this help?
No response
Extra details (optional)
An initial plan has been made in docs/_plan.md this is a good starting point for working out a new organisation and content for the docs.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/_plan.md to understand the proposed organisation and content. Review the current docs site against the plan, focusing on onboarding, feature coverage, Soundscapy's organisation, and links to further information. Done means the docs are reorganised and provide clear context for new users.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100