Autogenerate API docs
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- 機能追加
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- typescript
- 領域
- api, documentation
調査の方向性
まず、現在の API ドキュメントがどのように手動で作成されているかを確認し、そのプロセスを coder/coder の make gen と比較します。どの API ソースと生成される出力が関係するかを定義します。ドキュメントを確実に再生成でき、API の変更と整合した状態を維持できれば作業は完了です。
索引モデルが issue の本文から書いたものです。
説明
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
- 主要言語
- TypeScript
- スター
- 67
- フォーク
- 9
- PR マージ指標
- 30日以内にマージされた PR はありません
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
coder/backstage-plugins のほかの issue
-
enhancement good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
coder/backstage-plugins#105 · リアクション 1 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
coder/backstage-plugins#148 ·
-
Coder plugin: Fallback authentication button still appears after user has already authenticated オープンbug
coder/backstage-plugins#146 · 担当者 1 名 ·
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 45/100
coder/backstage-plugins#145 ·
-
bug help wanted
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
coder/backstage-plugins#144 · コメント 1 件 ·
coder/backstage-plugins の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
mksglu/context-mode#1200 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
jaegertracing/jaeger-ui#4506 ·
-
area:desktop area:ui bug platform:macos
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
anthropics/claude-code#96687 ·
-
good first issue
難易度 1/5 1時間未満 初心者へのやさしさ 95/100
AOSSIE-Org/DebateAI#582 · コメント 2 件 ·