Standardisation of sphinx docs page titles
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Área
- build-system, documentation
Línea de trabajo
Revisa primero la página de ejemplo en https://diamondlightsource.github.io/python-copier-template/main/how-to.html y la discusión del issue, ya que no se menciona ningún archivo fuente ni ninguna prueba. Confirma que el proyecto ha acordado una convención para los títulos e identifica el punto de entrada de la compilación de la documentación antes de delimitar una comprobación; se considera hecho cuando la convención está especificada explícitamente y la compilación la aplica de forma coherente.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- Jinja
- Estrellas
- 25
- Forks
- 10
- Merge medio
- 4 d 17 h
- PR fusionados (30 d)
- 7
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de DiamondLightSource/python-copier-template
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 68/100
-
documentation good first issue
Dificultad 1/5 Menos de una hora Aptitud para principiantes 70/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Todos los issues de DiamondLightSource/python-copier-template
Issues similares
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
-
CS0162 "Unreachable code detected" warning from a MSBuildTemp .tmp file in every game project Abiertobug
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
-
area:engineering priority:p2 type:bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
jejjohnson/pyrox#234 ·
-
good first issue
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
-
good first issue
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
ros2/ros2_tracing#266 · 1 comentario ·