[docs-infra] API type expander/explorer
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 99.1k
- Forks
- 32.5k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 106
Description
Summary
We could make it possible to expand the types that we show on the API docs pages. The idea being to expand types until you eventually land on the root docs pages (MDN or React docs).
Examples
https://github.com/mui/material-ui/assets/3165635/ca661a1b-8c1f-4495-a595-4899083c9824
Motivation
Improve DX. It's a bit similar to #41073 but going above and beyond.
Search keywords: API types expander
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 with the API docs page for ActionGroup and compare the proposed behavior with issue #41073 and the linked example. Define how API types should expand through the generated docs until reaching MDN or React documentation, and consider the work complete when this behavior is implemented consistently across API docs pages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- developer-experience, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100