Replies: 3 comments
-
I'd support that. README.md is accessible from the toctree of a project that's otherwise all-reST, so NP. |
Beta Was this translation helpful? Give feedback.
-
Hmm, no strong opinion either way from me. I agree that it's better for GitHub, and that it's a convention to have a README.md. |
Beta Was this translation helpful? Give feedback.
-
As of now, we are keeping the README in RST format as it aids in testing that the changes merged into the repo work as needed. We should replace this quasi testing with an actual QA test site that could be placed into a |
Beta Was this translation helpful? Give feedback.
-
GitHub, where this project lives and where the documentation it supports lives, does not have good support for RST. Markdown is the de facto standard on GitHub for the publication of text. Should we convert our README to Markdown? In issue #96 I'm advocating for another file too.
Beta Was this translation helpful? Give feedback.
All reactions