Consider using documentation.js instead of jsdoc
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 206
- Forks
- 12
- PR merge metrics
- No merged PRs in 30d
Description
While the [JSDoc project](https://github.com/jsdoc3/jsdoc) pioneered the generation of JS API references, [documentation.js](https://github.com/documentationjs/documentation) seems to be maintained more frequently, and also offers support for ES6+ code syntax.
Contributor guide
No contributing guide indexed for this repository
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 by comparing the JSDoc project and documentation.js using the linked project pages, then inspect how this repository currently generates its hosted API documentation. A complete outcome would define whether documentation.js should replace JSDoc and describe the migration scope, but the issue names no files or tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100