coder / coder/backstage-plugins
Autogenerate API docs
- Vorherrschende Sprache
- TypeScript
- Sterne
- 67
- Forks
- 9
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
Our format for API docs is great, but as they are manually created I can see how they can get out of sync quickly when we are making changes. We shouldn't do this before launch, but I wonder how we can autogenerate API docs, kind of like how we do wirth `make gen` on coder/coder
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Rechercherichtung
Beginne damit zu überprüfen, wie die aktuellen API-Dokumente manuell erstellt werden, und vergleiche diesen Prozess mit `make gen` in coder/coder. Lege fest, welche API-Quellen und generierten Ausgaben betroffen wären; die Arbeit ist abgeschlossen, wenn die Dokumentation zuverlässig neu generiert werden kann und mit API-Änderungen synchron bleibt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- api, documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100