Rewrite the docs

Offen

#863 erstellt am 30.12.2022 4 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 5/5
Geschätzter Aufwand: Über eine Woche
Anfängerfreundlichkeit: 25/100

Issue-Typ: Dokumentation
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: markdown, python
Bereich: documentation

Rechercherichtung

Start with the beta docs source at github.com/reactive-python/reactpy/tree/new-docs and compare it with the live preview and React's beta documentation. Map the existing reStructuredText documentation before evaluating the Markdown conversion and the listed versioning, macros, and Jupyter plugins. Done means the documentation is rewritten 1:1 in the proposed format and the resulting docs are usable for beginners.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

priority-1-high type-docs

Beta Docs Live Preview: https://reactive-python.github.io/reactpy/
Beta Docs Source Code: https://github.com/reactive-python/reactpy/tree/new-docs

Current Situation

It is difficult for new contributors to modify the docs, due to the current usage of reStructuredText (RST). Also the current verbiage is somewhat hard to understand for beginners.

Proposed Actions

Convert the current docs from reStructuredText (sphinx) to Markdown (mkdocs).

These new docs should be a 1:1 rewrite of ReactJS's documentation.

Also consider using these plugins

https://github.com/jimporter/mike for docs versioning
https://github.com/fralau/mkdocs_macros_plugin for code actions
https://github.com/greenape/mknotebooks or https://github.com/danielfrg/mkdocs-jupyter for embedding jupyter into the page

Related issues

#845
#779
#653
#647
#349
#568
#780

Vorherrschende Sprache: Python
Sterne: 8.1k
Forks: 332
PR-Merge-Kennzahlen: Keine gemergten PRs in 30 T.

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 reactive-python/reactpy

Outdated GIF in Docs Offen

priority-3-low type-docs

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100

reactive-python/reactpy#1034 · Erstellt am 09.6.2023
Allow JavaScript components inside of props dict Offen

priority-2-moderate type-revision

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100

reactive-python/reactpy#1319 · Erstellt am 15.12.2025
Create PyScript-compatible interface for ReactPy SSR and ReactJS components Offen

priority-1-high

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100

reactive-python/reactpy#1277 · Erstellt am 13.2.2025
Add MicroPython as ReactPy executor Offen

priority-3-low

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 35/100

reactive-python/reactpy#1273 · 1 Reaktion · Erstellt am 11.2.2025
ReactPy static site generation (SSG) Offen

priority-2-moderate

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 30/100

reactive-python/reactpy#1272 · 2 Reaktionen · Erstellt am 11.2.2025

Alle Issues in reactive-python/reactpy