coder / coder/backstage-plugins
Autogenerate API docs
オープン
- 主要言語
- TypeScript
- スター
- 67
- フォーク
- 9
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
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
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
調査の方向性
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.
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- api, documentation
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100