react-docgen
react-docgen copied to clipboard
Documentation missing for most features
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?
I was going to create the same issue. It would really help me use this project if it were documented more thoroughly.
Here is a landscape of what is documented so far as of today:
-
Getting started
- Node.js ✅
- CLI ✅
-
Extending
- Architecture ❌
- Resolver ❌
- Handler ❌
- Importer ❌
-
Reference
- Config ❌
- API ❌
-
Documentation
- Basic ✅
- PropTypes ❌
- TypeScript ❌
- Flow ❌
- FileState ✅
-
Handlers
- childContextType ❌
- codeType ❌
- componentDocblock ✅
- componentMethods ✅
- contextType ❌
- defaultProps ✅
- displayName ✅
- propDocblock ✅
- propTypeComposition ✅
- propType ✅
- CLI ✅
-
Migrate
- v5 to v6 ✅
-
Release Notes
- react-docgen ✅
- @react-docgen/cli ✅