Skip to content
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

Open
Archmonger opened this issue Dec 30, 2022 · 4 comments · May be fixed by #1052
Open

Rewrite the docs #863

Archmonger opened this issue Dec 30, 2022 · 4 comments · May be fixed by #1052
Labels
flag-good-first-issue A well defined and self-contained task. priority-1-high Should be resolved ASAP. type-docs About changes and updates to documentation

Comments

@Archmonger
Copy link
Contributor

Archmonger commented Dec 30, 2022

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

@Archmonger Archmonger added type-docs About changes and updates to documentation flag-good-first-issue A well defined and self-contained task. priority-3-low May be resolved one any timeline. labels Dec 30, 2022
@Archmonger Archmonger added this to the 1.0 milestone Dec 30, 2022
@rmorshea
Copy link
Collaborator

rmorshea commented Dec 30, 2022

Useful conversation to inform our decision to use mkdocs: encode/httpx#1220

It looks like they stuck with mkdocs in the end.

@Archmonger
Copy link
Contributor Author

Archmonger commented Dec 31, 2022

I created a draft of the new docs structure using mkdocs. Used django-idom docs as the initial template.

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:

pip install -r build-docs.txt
mkdocs serve

@Archmonger Archmonger removed the flag-good-first-issue A well defined and self-contained task. label Jan 22, 2023
@rmorshea rmorshea removed this from the 1.0 milestone Jan 24, 2023
@rmorshea
Copy link
Collaborator

rmorshea commented Jan 26, 2023

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.

@rmorshea
Copy link
Collaborator

mktestdocs also looks interesting.

@Archmonger Archmonger pinned this issue Jun 9, 2023
@Archmonger Archmonger unpinned this issue Jun 9, 2023
@Archmonger Archmonger changed the title Switch docs to mkdocs Rewrite the docs with mkdocs Jun 12, 2023
@Archmonger Archmonger added priority-1-high Should be resolved ASAP. and removed priority-3-low May be resolved one any timeline. labels Jun 14, 2023
@Archmonger Archmonger changed the title Rewrite the docs with mkdocs Rewrite the docs Jun 15, 2023
@Archmonger Archmonger pinned this issue Jun 15, 2023
@Archmonger Archmonger added the flag-good-first-issue A well defined and self-contained task. label Jun 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
flag-good-first-issue A well defined and self-contained task. priority-1-high Should be resolved ASAP. type-docs About changes and updates to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants