reactjs / reactjs/react-docgen
Documentation missing for most features
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 3.8k
- Forks
- 316
- Avg merge
- 5h 7m
- Merged PRs (30d)
- 4
Description
The current website is missing documentation for most features. Are there plans of adding this?
I'm trying to see how to use this tool to document components that use JSDoc for type definitions, and frankly don't know where to start. Is JSDoc even supported?
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 current website and the react-docgen repository description to inventory the tool's features and determine where documentation is missing. Check how component files using JSDoc type definitions are handled; done means the website explains supported features, usage, and whether JSDoc is supported.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100