Restructure docs directory
Mantenedores costumam responder em até 10 dias
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Facilidade para iniciantes
- 35/100
- Tipo de issue
- Documentação
- Clareza
- Precisa de esclarecimento
- Status de atividade
- Estagnada
- Domínio
- documentation
Direção de pesquisa
Comece revisando o diretório docs existente e a issue relacionada #1848 para identificar os tipos de documentação atualmente misturados. Defina uma estrutura que diferencie ADRs, conteúdo do Read the Docs e documentos diversos; considera-se concluído quando as categorias estiverem claramente separadas e a documentação existente continuar contemplada.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
Description of issue or feature request:
Current behavior:
No clear distinction of different documentation types in docs directory.
Expected behavior:
Clear distinction of different documentation types in docs directory, e.g. along the following categories:
- adr
- rtd (e.g. see
sphinx-quickstartdir scaffolding) - misc docs that are neither an adr, nor rendered on rtd (?)
related: see #1848
- Linguagem predominante
- Python
- Estrelas
- 1.7k
- Forks
- 304
- Merge médio
- 9h 25min
- PRs com merge (30d)
- 14
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Tem um modelo de pull request
- Ler o guia de contribuição
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 theupdateframework/python-tuf
-
switch to main branch?Aberta
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 48/100
theupdateframework/python-tuf#3001 ·
Mantenedores costumam responder em até 10 dias
-
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 42/100
theupdateframework/python-tuf#2979 · 1 comentário ·
Mantenedores costumam responder em até 10 dias
-
Use Immutable ReleasesAbertaenhancement github_actions
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 45/100
theupdateframework/python-tuf#2920 · 1 comentário · 2 reações ·
Mantenedores costumam responder em até 10 dias
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 35/100
theupdateframework/python-tuf#2842 · 3 comentários ·
Mantenedores costumam responder em até 10 dias
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 25/100
theupdateframework/python-tuf#2836 · 7 comentários ·
Mantenedores costumam responder em até 10 dias
Todas as issues de theupdateframework/python-tuf
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
solana-foundation/pay-kit#341 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
nasa/python_cmr#123 ·
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 92/100
EleutherAI/lm-evaluation-harness#4243 ·
Mantenedores costumam responder em até 1 dia
-
area: dashboard bug perceived difficulty: 3
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 88/100
Nitjsefnie-Harness-Commons/daedalus#1179 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 88/100
cusp-ai-oss/tojax#17 ·