[discovery] Splitting technical vs. design documentation for components
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 140
- Forks
- 100
- Avg merge
- 1h 3m
- Merged PRs (30d)
- 30
Description
- Understanding how to author documentation for technical vs. design in the MDX files.
- Understanding how we may be able to start supporting
Tabson the component docs template pages to split between technical vs. design (see Figma/screenshot).
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 documentation MDX files and the component docs template pages, then compare the requested technical/design split with the linked Figma exploration. Determine how Tabs could support the split and document or implement the agreed approach; done means the documentation structure and resulting component-page behavior are defined.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- design, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100