consider moving API docs into src
Open
Nobody has claimed this yet.
documentation
improve
- Dominant language
- JavaScript
- Stars
- 1.6k
- Forks
- 82
- PR merge metrics
- No merged PRs in 30d
Description
Evaluate JSDoc based tools to possibly move the API docs into the source files directly. This would make docs/api/**/*.md irrelevant.
Contributor guide
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 reviewing the existing docs/api/**/*.md files, then evaluate documentation.js, doctrine, and docchi against the current API documentation workflow. Determine whether the API docs can move into source files and record a clear decision about making the Markdown docs irrelevant.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100