Rewrite the docs
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- markdown, python
- Área
- documentation
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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
- Lenguaje dominante
- Python
- Estrellas
- 8.1k
- Forks
- 332
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de reactive-python/reactpy
-
Outdated GIF in Docs Abiertopriority-3-low type-docs
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
reactive-python/reactpy#1034 ·
-
priority-2-moderate type-revision
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
reactive-python/reactpy#1319 ·
-
priority-1-high
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
reactive-python/reactpy#1277 ·
-
priority-3-low
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
reactive-python/reactpy#1273 · 1 reacción ·
-
priority-2-moderate
Dificultad 5/5 Más de una semana Aptitud para principiantes 30/100
reactive-python/reactpy#1272 · 2 reacciones ·
Todos los issues de reactive-python/reactpy
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
-
🐛 Bug 🔔 Pending processing
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
jumpserver/jumpserver#17584 ·