collapsible sections on component docs pages?
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 140
- Forks
- 100
- Avg merge
- 1h 3m
- Merged PRs (30d)
- 30
Description
Inspired by this comment
As we add more examples to component pages on the docs site, it's possible users will feel overwhelmed with the amount of information presented at once.
It'd be great to ensure we don't overwhelm users, without scaling back the number of examples we provide for components.
One possible way to address this would be to add collapsible sections to the docs pages, so examples could be shown/hidden.
I'm sure there are other solutions to consider as well (hence marking this issue as "discovery")
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 component docs pages and the linked comment in Paragon pull request 2451. Compare collapsible examples with other ways to reduce information overload, then document a selected approach and its scope. Done means the discovery produces an agreed direction for improving how examples are presented.
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