Come up with plan for API documentation tooling
未關閉
還沒有人認領這個 Issue。
- 主要語言
- 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 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
研究方向
首先檢視目前對 documentation 4.0.0 的依賴，以及所參照的 documentationjs issue #850（關於已移除的 polygot 功能）。比較兩條提出的路徑——切換工具，或修正用法以支援較新的 release——並將完成條件定義為擁有一套有文件記錄且可正常運作的 API 文件設定。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- cpp, node.js
- 領域
- api, documentation, tooling
- Issue 類型
- 文件
- 難度
- 5/5
- 預估耗時
- 一週以上
- 活躍度
- 停滯
- 描述清晰度
- 需要釐清
- 新手友好度
- 25/100