Autogenerate API docs
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- typescript
- Área
- api, documentation
Línea de trabajo
Comienza revisando cómo se crean manualmente los documentos actuales de la API y compara ese proceso con make gen en coder/coder. Define qué fuentes de la API y qué salida generada estarían involucradas; el trabajo estará terminado cuando la documentación pueda regenerarse de forma fiable y se mantenga alineada con los cambios de la API.
Escrito por el modelo de indexación a partir del texto del issue.
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
- Lenguaje dominante
- TypeScript
- Estrellas
- 67
- Forks
- 9
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de coder/backstage-plugins
-
enhancement good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
coder/backstage-plugins#105 · 1 reacción ·
-
Update backstage dependencies Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
coder/backstage-plugins#148 ·
-
Coder plugin: Fallback authentication button still appears after user has already authenticated Abiertobug
coder/backstage-plugins#146 · 1 asignado ·
-
enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 45/100
coder/backstage-plugins#145 ·
-
bug help wanted
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
coder/backstage-plugins#144 · 1 comentario ·
Todos los issues de coder/backstage-plugins
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
mksglu/context-mode#1200 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
jaegertracing/jaeger-ui#4506 ·
-
area:desktop area:ui bug platform:macos
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
anthropics/claude-code#96687 ·
-
good first issue
Dificultad 1/5 Menos de una hora Aptitud para principiantes 95/100
AOSSIE-Org/DebateAI#582 · 2 comentarios ·