How to handle redundancy between params doc and tutorial doc
还没有人认领这个 Issue。
- 主要语言
- Ruby
- 星标
- 71
- 派生
- 27
- 平均合并
- 3 小时 3 分钟
- 30 天内合并 PR
- 2
描述
As I said in an earlier PR, my aim is for:
- The parameters doc to be about what the parameters do.
- The tutorial doc to be about what the user can do.
There will necessarily be considerable overlap, both the text and in the examples, but I'd like to avoid excessive redundancy.
I don't want the tutorial to "link out" very often. The tutorial reader is entitled to have the relevant material in-line, not linked to.
I'm thinking about having the parameters doc retain its explanatory text, but link to the specific tutorial section for examples. This would make the parameters doc much shorter -- a Good Thing in itself -- and also make the reader aware of the tutorial doc -- possibly another Good Thing.
I will value opinions.
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先比较参数文档与教程文档,重点关注其中的说明性文字、示例和链接。当项目在两份文档之间形成了约定的边界,并在不让教程读者依赖频繁链接的情况下减少了过度冗余时,这项工作就完成了。
由索引模型根据 Issue 内容生成。
评估
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 20/100