DiamondLightSource / DiamondLightSource/python-copier-template

Standardisation of sphinx docs page titles

Aberta
#232 14 comentários 0 reações 0 responsáveis Ver no GitHub
enhancement
Linguagem predominante
Jinja
Estrelas
25
Forks
10
Merge médio
4h 4min
PRs com merge (30d)
6

Descrição

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.

Guia de contribuição

Abrir o guia de contribuição

Direção de pesquisa

Revise primeiro a página de exemplo em https://diamondlightsource.github.io/python-copier-template/main/how-to.html e a discussão da issue, pois nenhum arquivo-fonte ou teste foi especificado. Confirme que o projeto chegou a um acordo sobre uma convenção de títulos e identifique o ponto de entrada do build da documentação antes de definir o escopo de uma verificação; considera-se concluído quando a convenção está explícita e o build a aplica de forma consistente.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Domínio
build-system, documentation
Tipo de issue
Documentação
Dificuldade
5/5
Tempo estimado
Mais de uma semana
Status de atividade
Estagnada
Clareza
Precisa de esclarecimento
Facilidade para iniciantes
25/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.