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

Installation docs...

Aperta Adatta ai principianti
#57 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
90/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Esamina la documentazione di installazione esistente nella directory docs del progetto, probabilmente sotto 'getting-started' o 'installation'. L'issue suggerisce di aggiornare le istruzioni per menzionare sia pip che uv, e di fornire un esempio chiaro e neutro. Controlla la documentazione di mkdocs per i passaggi di installazione attuali e revisionali per includere i comandi suggeriti: 'python3 -m venv venv', 'venv/bin/pip install mkdocs' e 'venv/bin/mkdocs', collegandosi anche alla documentazione di uv. Assicurati che le modifiche vengano apportate nei file markdown corretti e verifica costruendo la documentazione localmente.

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

Descrizione

pip and uv

I suppose let's be staightforward when we can, and link out to step-by-step walk throughs for new comers when needed.

Most of what I'm seeing these days recommends uv and they've got good little docs to point towards.
If we're doc'ing pip then python3 -m venv venv ... venv/bin/pip install mkdocs ... venv/bin/mkdocs is a dependable route.

We might want to use slightly neutral "Install the mkdocs python package..." then the console example.

Lingua principale
Python
Stelle
32
Fork
2
Merge medio
8h 51m
PR unite (30g)
15

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

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 encode/mkdocs

Tutte le issue di encode/mkdocs

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.