DiamondLightSource / DiamondLightSource/python-copier-template

Standardisation of sphinx docs page titles

オープン
#232 コメント 14 件 リアクション 0 件 担当者 0 名 GitHub で見る
enhancement
主要言語
Jinja
スター
25
フォーク
10
平均マージ
4時間 4分
マージ済み PR(30日)
6

説明

This may be the nitpickiest issue I have ever raised, so should not be actioned unless there's strong agreement.

![Image](https://github.com/user-attachments/assets/a1729ee3-5e8e-4789-b686-dca7b6d64ba0)
(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.

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

ソースファイルやテストが指定されていないため、まず https://diamondlightsource.github.io/python-copier-template/main/how-to.html のサンプルページと issue の議論を確認してください。チェックの範囲を決める前に、プロジェクトがタイトルの規約について合意していることを確認し、ドキュメントのビルドのエントリーポイントを特定してください。完了とは、その規約が明示され、ビルドによって一貫して強制されることです。

索引モデルが issue の本文から書いたものです。

評価

領域
build-system, documentation
issue の種類
ドキュメント
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。