Skip to content

Rewrite the docs #863

Open
Open
@Archmonger

Description

@Archmonger

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


Related issues

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority-1-highShould be resolved ASAP.type-docsAbout changes and updates to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions