Come up with plan for API documentation tooling
Open
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 74
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
We depend on documentation 4.0.0 as more recent releases removed polygot - refs documentationjs/documentation#850.
We either need to:
- Switch to a different tool
- Fix our usage of documentationjs to keep working with more recent versions
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 current dependency on documentation 4.0.0 and the referenced documentationjs issue #850 about the removed polygot feature. Compare the two proposed paths—switching tools or fixing usage for newer releases—and define completion as a documented, working API documentation setup.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, node.js
- Domain
- api, documentation, tooling
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100