Come up with plan for API documentation tooling
Aperta
Nessuno ha ancora preso questa issue.
- Lingua principale
- C++
- Stelle
- 74
- Fork
- 9
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia esaminando la dipendenza attuale da documentation 4.0.0 e la issue #850 di documentationjs citata relativa alla funzionalità polygot rimossa. Confronta i due percorsi proposti: cambiare strumento oppure correggere l’utilizzo per le release più recenti, e definisci il completamento come una configurazione documentata e funzionante della documentazione API.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- cpp, node.js
- Ambito
- api, documentation, tooling
- Tipo di issue
- Documentazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 25/100