Add a sitemap for docs
Open
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 118
- Forks
- 161
- PR merge metrics
- No merged PRs in 30d
Description
Adding a global sitemap, or index for all the docs (excluding the API docs), so that you can see them in one glance. It should include a subtitle (we can add a YAML header) to describe what the documentation article explains.
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 by identifying the documentation pages covered by the repository and how API docs are separated. Define the sitemap's one-glance listing and the subtitle metadata expected in each article; it is done when all non-API documentation is represented with descriptions.
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
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100