Skip to content

[Doc]: Migrate to Markdown #10427

@rafvasq

Description

@rafvasq

📚 The doc issue

Currently, documentation is written in ReStructuredText which is feature-rich but not as simple and popular as Markdown. This could be a barrier for people who are new to rST but want to contribute documentation.

Suggest a potential alternative/fix

Migrate the current docs to use MyST, a flavour of Markdown extended for use with Sphinx.

Before submitting a new issue...

  • Make sure you already searched for relevant issues, and asked the chatbot living at the bottom right corner of the documentation page, which can answer lots of frequently asked questions.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions