Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation missing for most features #933

Open
mryechkin opened this issue Jun 19, 2024 · 1 comment
Open

Documentation missing for most features #933

mryechkin opened this issue Jun 19, 2024 · 1 comment

Comments

@mryechkin
Copy link

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
Copy link

Jikodis commented Nov 4, 2024

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 ✅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants