Installation docs...
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- Unter einer Stunde
- Anfängerfreundlichkeit
- 90/100
- Issue-Typ
- Dokumentation
- Klarheit
- Klar beschrieben
- Aktivitätsstatus
- Aktiv
- Tech-Stack
- python
- Bereich
- documentation
Rechercherichtung
Schauen Sie sich die vorhandene Installationsdokumentation im docs-Verzeichnis des Projekts an, wahrscheinlich unter 'getting-started' oder 'installation'. Das Issue schlägt vor, die Anweisungen zu aktualisieren, um sowohl pip als auch uv zu erwähnen, und ein klares, neutrales Beispiel zu geben. Überprüfen Sie die mkdocs-Dokumentation für die aktuellen Installationsschritte und überarbeiten Sie sie, um die vorgeschlagenen Befehle einzufügen: 'python3 -m venv venv', 'venv/bin/pip install mkdocs' und 'venv/bin/mkdocs', während auch auf die Dokumentation von uv verlinkt wird. Stellen Sie sicher, dass die Änderungen in den richtigen Markdown-Dateien vorgenommen werden und überprüfen Sie dies durch lokales Bauen der Dokumentation.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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.
- Vorherrschende Sprache
- Python
- Sterne
- 32
- Forks
- 2
- Ø Merge
- 8 Std. 51 Min.
- Gemergte PRs (30 T.)
- 15
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus encode/mkdocs
-
Licensing Offen
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100
-
Reminders... Offen
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100
Ähnliche Issues
-
agent-ready documentation needs-triage
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 88/100
-
documentation
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" Offen
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 92/100
-
instance instance add
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 72/100
searxng/searx-instances#939 · 1 Kommentar ·
-
area-deployment area-integrations triage:bot-seen
Schwierigkeit 2/5 Ein halber Tag Anfängerfreundlichkeit 86/100