Open
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
- Improve
use_context
docs #845 - Use snake_case for components #779
- Embedding ReactPy via Template Tags #653
- Improve JavaScript components docs #647
- Add docs section for Common utils (e.g. the stuff in reactpy.widgets) #349
- Add Example of Bug Due to Mutation in "Dangers of Mutability" #568
- Explore JupyterLite-Sphinx for interactive examples in docs #780
Metadata
Metadata
Assignees
Labels
A well defined and self-contained task.A well defined and self-contained task.Should be resolved ASAP.Should be resolved ASAP.About changes and updates to documentationAbout changes and updates to documentation