-
-
Notifications
You must be signed in to change notification settings - Fork 318
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rewrite the docs #863
Comments
Useful conversation to inform our decision to use mkdocs: encode/httpx#1220 It looks like they stuck with mkdocs in the end. |
I created a draft of the new docs structure using https://github.com/Archmonger/idom-docs Currently, the only thing that has been developed is the navigation names, and website theme. Can be previewed by typing the following:
|
Looking at the docs for Textual (a popular terminal UI framework) I found a list of mkdocs plugins and extensions we might want to consider using. |
mktestdocs also looks interesting. |
Beta Docs: 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
Related issues
use_context
docs #845The text was updated successfully, but these errors were encountered: