Allow using jsdoc and typedoc in the same project
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 290
- Forks
- 80
- PR merge metrics
- No merged PRs in 30d
Description
There's no reason we shouldn't support the gradual migration of projects. We can run both tools and fill a common SuffixTree. The config directives will have to be redesigned, as they currently assume JS xor TS.
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 examining the existing configuration directives and the SuffixTree integration described in the issue. Done means a project can run JSDoc and TypeDoc together, with both outputs contributing to one common SuffixTree and configuration no longer assuming JavaScript or TypeScript exclusively.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100