Add documentation for exposed types
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- typescript
调研方向
先检查 TypeScript 导出的类型和接口，然后比较 issue 中提到的文档生成选项：TypeDoc、typegen 和 api-extractor。完成标准是：已为暴露的类型生成面向用户的文档，并且所选方案已集成到项目中。
由索引模型根据 Issue 内容生成。
描述
Is your feature request related to a problem? Please describe.
There is absolutely no user-facing documentation for any of the exposed types/interfaces.
Describe the solution you'd like
Autogeneration of documentation from the exported types would be nice.
Describe alternatives you've considered
A simple web search turns up a few options, such as this or this. Additionally, api-extractor, which I've looked into using for other reasons, can do this as well.
- 主要语言
- TypeScript
- 星标
- 440
- 派生
- 61
- 平均合并
- 4 天 3 小时
- 30 天内合并 PR
- 16
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
StackExchange/Stacks-Editor 的其他 Issue
-
enhancement
难度 4/5 3-5 天 新手友好度 35/100
StackExchange/Stacks-Editor#504 · 1 条评论 · 2 个 reaction ·
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 25/100
StackExchange/Stacks-Editor#395 · 1 条评论 ·
维护者通常 1 天内回复
-
enhancement
难度 4/5 3-5 天 新手友好度 35/100
StackExchange/Stacks-Editor#343 · 1 条评论 ·
维护者通常 1 天内回复
-
enhancement
难度 4/5 3-5 天 新手友好度 35/100
StackExchange/Stacks-Editor#272 · 1 条评论 ·
维护者通常 1 天内回复
-
enhancement
难度 5/5 一周以上 新手友好度 35/100
StackExchange/Stacks-Editor#250 · 1 条评论 ·
维护者通常 1 天内回复
查看 StackExchange/Stacks-Editor 的全部 Issue
相似的 Issue
-
area/frontend area/v2 kind/bug priority/needs-triage
难度 2/5 1-3 小时 新手友好度 70/100
kubeflow/notebooks#1498 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 75/100
维护者通常 1 天内回复
-
P1
难度 2/5 1-3 小时 新手友好度 66/100
SuruchBoss/Cwork#90 ·
-
bug cli service
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 85/100
521xueweihan/HelloGitHub#3922 ·