[docs] Improve documentation discoverability
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 99.1k
- Forks
- 32.5k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 106
Description
Duplicates
- I have searched the existing issues
Latest version
- I have tested the latest version
Summary 💡
Documentation that is simple structured and easy to catch up
Examples 🌈
https://reshaped.so/content/docs/getting-started/overview
Motivation 🔦
If I visit the MUI documentation, I'm a bit confused about the different areas
and inside the documentation I think the structure can be also optimized. I've sharing one example that I found, that I really like from the visibility (Although it's not yet so extensive like MUI)
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
Review the current MUI documentation areas and structure alongside the linked Reshaped documentation example and the provided screenshot. The issue does not name files or a specific documentation change, so first define the navigation or organization problems to address; done should mean a concrete, agreed restructuring with improved discoverability.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100