Closed regisb closed 1 year ago
@overhangio/tutor-maintainers could you please review this PR? If you're happy with the proposed changes, please open a similar PR in the repos you maintain. Thanks!
For tutor-mfe: https://github.com/overhangio/tutor-mfe/issues/118
I wonder would it be okay to change the Readme file extension from rst
to md
? Would that have any consequences long or short term
I wonder would it be okay to change the Readme file extension from rst to md? Would that have any consequences long or short term
There are no serious consequences that I can think of. I picked rst as a README format early on, because in my experience this makes it much easier to convert a long readme to a full sphinx-compatible docs site. I'm not sure I would agree on an rst -> md conversion, but we can certainly discuss it.
This is to address https://github.com/overhangio/tutor/issues/746