coder / coder/backstage-plugins
Autogenerate API docs
- Dominant language
- TypeScript
- Stars
- 67
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
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
Contributor guide
No contributing guide indexed for this repository
Research direction
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.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100