search

mozilla / mig

Distributed & real time digital forensics at the speed of the cloud
http://mig.mozilla.org/
Mozilla Public License 2.0
1.21k stars 234 forks source link

Move all documentation over to markdown #470

Open arcrose opened 6 years ago

arcrose commented 6 years ago

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.

Julian-Mentasti commented 6 years ago

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

arcrose commented 6 years ago

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 commented 6 years ago

alright

jdel7 commented 5 years ago

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

jdel7 commented 5 years ago

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.