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