Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

Update docs to use Render Engine

Offen
#1,151 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
42/100
Issue-Typ
Refactoring
Klarheit
Größtenteils klar
Aktivitätsstatus
Ruhig
Tech-Stack
python

Rechercherichtung

Beginne damit, die Skripte für den Dokumentations-Build und die referenzierte mkdocs.yml zu lokalisieren, und untersuche anschließend, wie die aktuelle MkDocs-Distribution zusammengestellt wird. Teile die Arbeit in das vorgeschlagene Theme, das Plugin für die Verarbeitung von mkdocs.yml und die Skriptaktualisierungen auf, und verifiziere, dass die Dokumentationsdistribution Render Engine statt MkDocs verwendet.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

feature

Seeing as we write an SSG there is no reason for us to use mkdocs to create our documentation for distribution. We should be using Render Engine.

The switch will not necessarily be simple, however we should be able to accomplish it in stages.

  1. A theme for the docs
  2. A plugin to handle the mkdocs.yml
  3. Updating scripts to us RE and not mkdocs
Vorherrschende Sprache
Python
Sterne
64
Forks
46
Ø Merge
1 T. 18 Std.
Gemergte PRs (30 T.)
17

Entwicklungsumgebung

In Codespaces öffnen

Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.

  • Kein Dockerfile und keine Docker-Compose-Datei
  • Hat eine Pull-Request-Vorlage
  • Kein Beitragsleitfaden

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus render-engine/render-engine

Alle Issues in render-engine/render-engine

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.