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
贡献指南
这个仓库没有索引到贡献指南
调研方向
首先,审查当前 API 文档是如何手动创建的,并将该流程与 coder/coder 中的 `make gen` 进行比较。明确涉及哪些 API 源和生成的输出;当文档能够可靠地重新生成并与 API 变更保持一致时,这项工作就完成了。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- typescript
- 领域
- api, documentation
- Issue 类型
- 功能
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 25/100