writethedocs / www

The main website for Write the Docs.
http://www.writethedocs.org
Other
1.32k stars 512 forks source link

Convert guide to Markdown #1509

Open ericholscher opened 3 years ago

ericholscher commented 3 years ago

We should use the same format for the guide. It's confusing to have rst & markdown mixed, and now Sphinx has great markdown support:

ericholscher commented 2 years ago

We are moving to a more recent version of markdown here: #1738

djwfyi commented 1 year ago

So is the idea to convert all existing content to markdown?

ericholscher commented 1 year ago

@djwfyi Not really. Mostly just to offer the option to write in RST or MD, whichever is easiest. I think we should try to keep various sections in a similar format if possible though, so it's less confusing.

This was about the guide specifically, with the goal of making contribution easier. However, as you've noted elsewhere, the guide is still not super well structured. I think probably some kind of merging of the guide & topic index is likely a better approach in terms of content management, and that's outside of any specific tooling or markup choice.

rukundob451 commented 1 year ago

@ericholscher, is this issue still open to be worked on?