reactjs / react-docgen

A CLI and library to extract information from React component files for documentation generation purposes.
https://react-docgen.dev
MIT License
3.67k stars 296 forks source link

Documentation missing for most features #933

Open mryechkin opened 4 months ago

mryechkin commented 4 months ago

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?

Jikodis commented 3 days ago

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: