Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Restructure docs directory

Ouverte
#1,849 3 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 10 jours

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
35/100
Type d'issue
Documentation
Clarté
À clarifier
Activité
À l'abandon
Domaine
documentation

Piste de recherche

Commencez par examiner le répertoire docs existant et l’issue associée #1848 afin d’identifier les types de documentation actuellement mélangés. Définissez une structure qui distingue les ADRs, le contenu de Read the Docs et les documents divers ; le travail est considéré comme terminé lorsque les catégories sont clairement séparées et que la documentation existante reste prise en compte.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

documentation low-prio

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-quickstart dir scaffolding)
  • misc docs that are neither an adr, nor rendered on rtd (?)

related: see #1848

Langage dominant
Python
Étoiles
1.7k
Forks
304
Merge moyen
9 h 25 min
PR mergées (30 j)
14

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de theupdateframework/python-tuf

Toutes les issues de theupdateframework/python-tuf

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.