Standardisation of sphinx docs page titles
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Facilidade para iniciantes
- 25/100
- Tipo de issue
- Documentação
- Clareza
- Precisa de esclarecimento
- Status de atividade
- Estagnada
- Domínio
- build-system, documentation
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.
Descrição
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.
- Linguagem predominante
- Jinja
- Estrelas
- 25
- Forks
- 10
- Merge médio
- 4d 17h
- PRs com merge (30d)
- 7
Preparar o ambiente
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de DiamondLightSource/python-copier-template
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 68/100
-
documentation good first issue
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 70/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
Todas as issues de DiamondLightSource/python-copier-template
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
opengovsg/FormSG#10118 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
Support git worktreesAberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
block/artifact-swap#176 ·
-
area:lint-tooling bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 88/100
InauguralSystems/EigenScript#1340 ·
Mantenedores costumam responder em até 1 dia
-
ADR-0001, ADR-0002, ADR-0003Abertaadr part:1
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 85/100
tiarebalbi/bullpen#3 ·
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 88/100
Mantenedores costumam responder em até 4 dias