You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently the README is in reStructuredText, which has some disadvantages:
It's unintuitive compared to Markdown, especially for newcomers. (I haven't used it in a long time, and I'm having a difficult time making changes to it, especially given that I have no way to live-preview my changes on my local system.)
It's not possible to easily copy content to/from other Markdown content--e.g. other project READMEs, or instructions.md, or GitHub comments.
The only potential advantage I see in using RST is that it'll be easy to migrate our documentation to Sphinx, but I don't see that happening anytime soon...
Currently the README is in reStructuredText, which has some disadvantages:
instructions.md, or GitHub comments.The only potential advantage I see in using RST is that it'll be easy to migrate our documentation to Sphinx, but I don't see that happening anytime soon...