Documentation for JSDoc support

Open
#458 1 comment 7 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
38/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
react, typescript
Domain
documentation

Research direction

Start with the README and the repository's JSDoc support entry points. Document how to use JSDoc with react-docgen and clearly describe the supported subset of JSDoc syntax, so readers can understand the feature without relying on issue discussion.

Written by the indexing model from the issue text.

Description

In the README there is no mention of JSDoc and what subset of JSDoc syntax react-docgen supports.
Would help to have some documentation explaining the usage with JSDoc.

Dominant language
TypeScript
Stars
3.8k
Forks
316
Avg merge
3h 28m
Merged PRs (30d)
6

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from reactjs/react-docgen

All issues in reactjs/react-docgen

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.