mapbox / mapbox/node-cpp-skel

Come up with plan for API documentation tooling

Open
#150 0 comments 0 reactions 0 assignees View on GitHub
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

Open the contributing guide

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.