A prerequisites panel for each page
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 73
- Forks
- 280
- Avg merge
- 20h 52m
- Merged PRs (30d)
- 4
Description
I think the docs could benefit from certain pages having some way to check the page's prerequisites. This way, if a page is linked to a new user, they do not get confused about some used API, which is explained on a different page. This would also remove the need to give a brief explanation on some slightly niche, but still documented API if it is used on another page.
Currently not sure how that would look. It could be on the side bar, just like the 'written-for' label?
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 reviewing the documentation sidebar and the existing “written-for” label mentioned in the issue. First agree on how prerequisites should appear and which pages need them; done means the design is settled and the selected documentation pages consistently expose their prerequisites.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100