Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert guide to Markdown #1509

Open
ericholscher opened this issue Apr 25, 2021 · 4 comments
Open

Convert guide to Markdown #1509

ericholscher opened this issue Apr 25, 2021 · 4 comments

Comments

@ericholscher
Copy link
Member

ericholscher commented Apr 25, 2021

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
Copy link
Member Author

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

@djwfyi
Copy link
Collaborator

djwfyi commented Mar 4, 2023

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

@ericholscher
Copy link
Member Author

ericholscher commented Mar 6, 2023

@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
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants