coder / coder/backstage-plugins
Autogenerate API docs
- Lenguaje dominante
- TypeScript
- Estrellas
- 67
- Forks
- 9
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Línea de trabajo
Start by reviewing how the current API docs are manually created and compare that process with `make gen` in coder/coder. Define what API sources and generated output would be involved; the work is done when the documentation can be regenerated reliably and stays aligned with API changes.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- typescript
- Área
- api, documentation
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 25/100