DiamondLightSource / DiamondLightSource/python-copier-template

Standardisation of sphinx docs page titles

Aperta
#232 14 commenti 0 reazioni 0 assegnatari Vedi su GitHub
enhancement
Lingua principale
Jinja
Stelle
25
Fork
10
Merge medio
4h 4m
PR unite (30g)
6

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Review the example page at https://diamondlightsource.github.io/python-copier-template/main/how-to.html and the issue discussion first, since no source file or test is named. Confirm that the project has agreed on a title convention and identify the docs build entry point before scoping a check; done means the convention is explicit and the build consistently enforces it.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Ambito
build-system, documentation
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.