Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Restructure docs directory

Aperta
#1,849 3 commenti 1 reazione 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 10 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Ambito
documentation

Direzione di ricerca

Inizia esaminando la directory docs esistente e la issue correlata #1848 per identificare i tipi di documentazione attualmente mescolati. Definisci una struttura che distingua gli ADRs, i contenuti di Read the Docs e i documenti vari; il lavoro è completato quando le categorie sono chiaramente separate e la documentazione esistente continua a essere inclusa.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
Python
Stelle
1.7k
Fork
304
Merge medio
9h 25m
PR unite (30g)
14

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di theupdateframework/python-tuf

Tutte le issue di theupdateframework/python-tuf

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.