Rewrite the docs
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 25/100
- Type d'issue
- Documentation
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- markdown, python
- Domaine
- documentation
Piste de recherche
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.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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
- Langage dominant
- Python
- Étoiles
- 8.1k
- Forks
- 332
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de reactive-python/reactpy
-
Outdated GIF in Docs Ouvertepriority-3-low type-docs
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
reactive-python/reactpy#1034 ·
-
priority-2-moderate type-revision
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100
reactive-python/reactpy#1319 ·
-
priority-1-high
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100
reactive-python/reactpy#1277 ·
-
priority-3-low
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 35/100
reactive-python/reactpy#1273 · 1 réaction ·
-
priority-2-moderate
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 30/100
reactive-python/reactpy#1272 · 2 réactions ·
Toutes les issues de reactive-python/reactpy
Issues similaires
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 90/100
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 86/100
zostera/django-bootstrap4#894 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
use-agent-os/agent-os#3276 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
zephyrproject-rtos/zephyr#119726 ·
-
area/auth bug comp/agent P3 platform/discord type/security
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
NousResearch/hermes-agent#117848 ·