Rewrite the docs
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- markdown, python
- Ambito
- documentation
Direzione di ricerca
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.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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
- Lingua principale
- Python
- Stelle
- 8.1k
- Fork
- 332
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di reactive-python/reactpy
-
Outdated GIF in Docs Apertapriority-3-low type-docs
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
reactive-python/reactpy#1034 ·
-
priority-2-moderate type-revision
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
reactive-python/reactpy#1319 ·
-
priority-1-high
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
reactive-python/reactpy#1277 ·
-
priority-3-low
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
reactive-python/reactpy#1273 · 1 reazione ·
-
priority-2-moderate
Difficoltà 5/5 Più di una settimana Idoneità per principianti 30/100
reactive-python/reactpy#1272 · 2 reazioni ·
Tutte le issue di reactive-python/reactpy
Issue simili
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 86/100
zostera/django-bootstrap4#894 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
use-agent-os/agent-os#3276 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
zephyrproject-rtos/zephyr#119726 ·
-
area/auth bug comp/agent P3 platform/discord type/security
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
NousResearch/hermes-agent#117848 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
zilliztech/memsearch#759 ·