Hi all,

Currently the documentation for the TVM site is written in 
[ReStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html).
 However, just about everything else we do is in Markdown:
- this forum
- github
- discord

Needing to know two languages makes it harder for people to contribute docs. It 
is [possible](https://www.sphinx-doc.org/en/master/usage/markdown.html) to use 
Markdown with Sphinx (the tool we use to generate the docs).

What do people think about trying to convert the TVM docs site to Markdown? I 
did a 
[demo](https://github.com/areusch/incubator-tvm/blob/markdown-demo/docs/dev/test.md#codegen)
 of using Markdown with Sphinx. Feel free to pull and build the doc (note you 
may need [8828](https://github.com/apache/tvm/pull/8268) to work around a bug 
with our layout in both RST and MD) to try it out.

This approach requires that we use some markdown extensions to interact with 
Sphinx. There's some documentation on these 
[here](https://myst-parser.readthedocs.io/en/latest/sphinx/index.html).

Would love to get thoughts/feedback on this idea!

Andrew





---
[Visit 
Topic](https://discuss.tvm.apache.org/t/docs-discuss-convert-restructuredtext-docs-to-markdown/10264/1)
 to respond.

You are receiving this because you enabled mailing list mode.

To unsubscribe from these emails, [click 
here](https://discuss.tvm.apache.org/email/unsubscribe/fc46a7fd05d2dbd287321365c03acd1941fc34ea3176aa2f692339939002c8b4).

Reply via email to