coder / coder/backstage-plugins
Autogenerate API docs
- Langage dominant
- TypeScript
- Étoiles
- 67
- Forks
- 9
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
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
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Piste de recherche
Commencez par examiner comment la documentation actuelle de l’API est créée manuellement et comparez ce processus avec `make gen` dans coder/coder. Définissez quelles sources d’API et quelles sorties générées seraient concernées ; le travail est terminé lorsque la documentation peut être régénérée de manière fiable et reste alignée sur les changements de l’API.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- api, documentation
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 25/100