Come up with plan for API documentation tooling
Offen
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- C++
- Sterne
- 74
- Forks
- 9
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der Überprüfung der aktuellen Abhängigkeit von documentation 4.0.0 und des referenzierten documentationjs-Issues #850 zur entfernten polygot-Funktion. Vergleiche die beiden vorgeschlagenen Wege – den Wechsel des Tools oder die Anpassung der Nutzung für neuere Releases – und definiere den Abschluss als eine dokumentierte, funktionierende Einrichtung der API-Dokumentation.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- cpp, node.js
- Bereich
- api, documentation, tooling
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100