Standardisation of sphinx docs page titles
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
调研方向
首先查看 https://diamondlightsource.github.io/python-copier-template/main/how-to.html 上的示例页面和 issue 讨论，因为其中没有指定源文件或测试。确定项目已经就标题约定达成一致，并在确定检查范围之前找出文档构建的入口点；完成的标准是该约定已明确规定，并且构建始终对其进行强制执行。
由索引模型根据 Issue 内容生成。
描述
This may be the nitpickiest issue I have ever raised, so should not be actioned unless there's strong agreement.
(from https://diamondlightsource.github.io/python-copier-template/main/how-to.html)
It annoys me that the titles for docs pages are not really standardised, Some Are Capitalised, some are not, some are prefixed with "How to" or similar. If there is a really easy check that can be added to the docs builds it might add a layer of consistency and professionalism. The hardest part, as ever when we talk about formatting, may be agreeing on which standard to use.
- 主要语言
- Jinja
- 星标
- 25
- 派生
- 10
- 平均合并
- 4 天 17 小时
- 30 天内合并 PR
- 7
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
DiamondLightSource/python-copier-template 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
-
难度 2/5 1-3 小时 新手友好度 72/100
-
难度 1/5 1 小时以内 新手友好度 68/100
-
documentation good first issue
难度 1/5 1 小时以内 新手友好度 70/100
-
难度 2/5 1-3 小时 新手友好度 68/100
查看 DiamondLightSource/python-copier-template 的全部 Issue
相似的 Issue
-
Name consistency 未关闭
难度 2/5 1-3 小时 新手友好度 75/100
eellak/triplestore#65 · 1 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 70/100
google-ai-edge/LiteRT-LM#3739 ·
-
难度 2/5 1-3 小时 新手友好度 70/100
-
area-Bzlmod team-ExternalDeps type: bug untriaged
难度 2/5 1-3 小时 新手友好度 65/100
bazelbuild/bazel#31291 · 2 条评论 ·
-
bug
难度 2/5 1-3 小时 新手友好度 75/100
bradcypert/plum#53 ·