-
Type: Task
-
Resolution: Fixed
-
Priority: Unknown
-
Affects Version/s: None
-
Component/s: None
-
None
Context
Markdown is easier to write and is interoperable with more tools. We can use pandoc to convert the files.
brew install pandoc pandoc -f rst -t markdown CONTRIBUTING.rst > CONTRIBUTING.md
Definition of done
Top level RST files are converted to MD.
Pitfalls
Ensure that no information is lost and that the docs render properly on GitHub.
- is related to
-
PYTHON-4047 Convert top level docs files to Markdown
- Closed