Auto-generate the file-level documentation from its contents
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 35/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- cpp, jekyll
- 领域
- documentation, tooling
调研方向
首先跟踪 brief 和 owner 字段当前如何在类文档中表示，以及如何复制到每个文件的 index.md 中。比较单个类的情况与包含多个子实体的文件，然后定义继承字段或可选字段应如何表现，以及哪些文档输出应确认这一变更。
由索引模型根据 Issue 内容生成。
描述
The brief and owner fields in index.md for a class and the file that contains it should be inherited (somehow) from the class documentation itself. When there's a single class in a file, it seems silly to copy the brief and owner up to the index file(s).
Another option would be to make those fields __OPTIONAL__ if there's a single sub-entity in the file. No need to copy if it's just going to be redundant.
- 主要语言
- C++
- 星标
- 341
- 派生
- 45
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
adobe/hyde 的其他 Issue
-
难度 3/5 1-2 天 新手友好度 35/100
-
难度 4/5 3-5 天 新手友好度 25/100
-
难度 5/5 一周以上 新手友好度 15/100
-
难度 5/5 一周以上 新手友好度 35/100
-
难度 4/5 3-5 天 新手友好度 35/100
相似的 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 76/100
维护者通常 3 天内回复
-
backlog
难度 2/5 1-3 小时 新手友好度 78/100
EchoTools/nevr-runtime#2385 ·
维护者通常 1 天内回复
-
type:bug
难度 2/5 1-3 小时 新手友好度 65/100
tensorflow/tflite-micro#3995 ·
维护者通常 1 天内回复
-
CPU update 1.31x未关闭speed-report
难度 1/5 1 小时以内 新手友好度 75/100
mw00/project-maya#961 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100