Standardisation of sphinx docs page titles
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 25/100
- Type d'issue
- Documentation
- Clarté
- À clarifier
- Activité
- À l'abandon
- Domaine
- build-system, documentation
Piste de recherche
Examinez d’abord la page d’exemple à l’adresse https://diamondlightsource.github.io/python-copier-template/main/how-to.html et la discussion de l’issue, puisqu’aucun fichier source ni aucun test n’est indiqué. Confirmez que le projet s’est mis d’accord sur une convention de titre et identifiez le point d’entrée du build de la documentation avant de définir le périmètre d’une vérification ; c’est terminé lorsque la convention est explicite et que le build l’applique systématiquement.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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.
- Langage dominant
- Jinja
- Étoiles
- 25
- Forks
- 10
- Merge moyen
- 4 j 17 h
- PR mergées (30 j)
- 7
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de DiamondLightSource/python-copier-template
-
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 68/100
-
documentation good first issue
Difficulté 1/5 Moins d'une heure Accessibilité débutants 70/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
Toutes les issues de DiamondLightSource/python-copier-template
Issues similaires
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 85/100
-
CS0162 "Unreachable code detected" warning from a MSBuildTemp .tmp file in every game project Ouvertebug
Difficulté 1/5 Moins d'une heure Accessibilité débutants 90/100
-
area:engineering priority:p2 type:bug
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
jejjohnson/pyrox#234 ·
-
good first issue
Difficulté 1/5 Moins d'une heure Accessibilité débutants 90/100
-
good first issue
Difficulté 1/5 Moins d'une heure Accessibilité débutants 85/100
ros2/ros2_tracing#266 · 1 commentaire ·