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

[Doc]: Migrate to Markdown #10427

Closed
1 task done
rafvasq opened this issue Nov 18, 2024 · 3 comments · Fixed by #11145
Closed
1 task done

[Doc]: Migrate to Markdown #10427

rafvasq opened this issue Nov 18, 2024 · 3 comments · Fixed by #11145
Labels
documentation Improvements or additions to documentation

Comments

@rafvasq
Copy link
Contributor

rafvasq commented Nov 18, 2024

📚 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.
@rafvasq rafvasq added the documentation Improvements or additions to documentation label Nov 18, 2024
@Isotr0py
Copy link
Collaborator

Isotr0py commented Nov 18, 2024

Agreed. If we migrate to markdown, I think we can also get a quick preview of documentation from previewer during writing without massive re-building.

@simon-mo
Copy link
Collaborator

I support this!

@DarkLight1337
Copy link
Member

+1!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants