Rewrite the docs
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- markdown, python
- Domain
- documentation
Research direction
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.
Written by the indexing model from the issue text.
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
- Dominant language
- Python
- Stars
- 8.1k
- Forks
- 332
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from reactive-python/reactpy
-
Outdated GIF in Docs Openpriority-3-low type-docs
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
reactive-python/reactpy#1034 ·
-
priority-2-moderate type-revision
Difficulty 5/5 Over a week Newbie friendliness 25/100
reactive-python/reactpy#1319 ·
-
priority-1-high
Difficulty 5/5 Over a week Newbie friendliness 25/100
reactive-python/reactpy#1277 ·
-
priority-3-low
Difficulty 5/5 Over a week Newbie friendliness 35/100
reactive-python/reactpy#1273 · 1 reaction ·
-
priority-2-moderate
Difficulty 5/5 Over a week Newbie friendliness 30/100
reactive-python/reactpy#1272 · 2 reactions ·
All issues in reactive-python/reactpy
Similar issues
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
simonw/sqlite-utils#872 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100