Come up with plan for API documentation tooling
オープン
まだ誰も着手していません。
- 主要言語
- C++
- スター
- 74
- フォーク
- 9
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
We depend on documentation 4.0.0 as more recent releases removed `polygot` - refs documentationjs/documentation#850.
We either need to:
- [ ] Switch to a different tool
- [ ] Fix our usage of documentationjs to keep working with more recent versions
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、現在の documentation 4.0.0 への依存と、削除された polygot 機能に関する参照先の documentationjs issue #850 を確認します。提案されている2つの方針、つまりツールを切り替えるか、新しいリリース向けに使用方法を修正するかを比較し、完了条件を、文書化され動作する API ドキュメントのセットアップとして定義します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- cpp, node.js
- 領域
- api, documentation, tooling
- issue の種類
- ドキュメント
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100