Skip to content
This repository has been archived by the owner on Sep 14, 2019. It is now read-only.

Move all documentation over to markdown #470

Open
arcrose opened this issue Oct 3, 2018 · 5 comments
Open

Move all documentation over to markdown #470

arcrose opened this issue Oct 3, 2018 · 5 comments
Labels
D-Easy Difficulty: Issues that should be relatively easy to resolve E-Mentor Call for participation: Issues that have mentors available MIG-Documentation Component: Issues concerning documentation P-Low Priority: Issues that can afford to be resolved when it is convenient to do so

Comments

@arcrose
Copy link
Contributor

arcrose commented Oct 3, 2018 •
edited
Loading

I think we could have nicer-formatted documentation if we used markdown, so I'd like to invite help moving in that direction.

I am happy to mentor and provide support on this issue.
@arcrose arcrose added P-Low Priority: Issues that can afford to be resolved when it is convenient to do so D-Easy Difficulty: Issues that should be relatively easy to resolve E-Mentor Call for participation: Issues that have mentors available MIG-Documentation Component: Issues concerning documentation labels Oct 3, 2018
@Julian-Mentasti
Copy link

I can help with this, where do you think would be a good starting point?

@arcrose
Copy link
Contributor Author

arcrose commented Oct 5, 2018

The doc/ directory is full of documents that could use replacing. I've started converting doc/api.rst to Markdown in my abstract-rabbit branch, but everything else is up for grabs.

@Julian-Mentasti
Copy link

alright

@jdel7
Copy link

jdel7 commented Dec 3, 2018

Hey @Julian-Mentasti, are you still working on moving the docs over to markdown? If not, I'd like to help.

@jdel7
Copy link

jdel7 commented Dec 7, 2018

Quick question @arcrose, do you want me to get rid of the .rst files as I convert them or keep them?

I just saw that you left api.rst and api.md in there so I'm happy to follow suit or I can get rid of the .rst files.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
D-Easy Difficulty: Issues that should be relatively easy to resolve E-Mentor Call for participation: Issues that have mentors available MIG-Documentation Component: Issues concerning documentation P-Low Priority: Issues that can afford to be resolved when it is convenient to do so
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@arcrose @jdel7 @Julian-Mentasti