openworm / org.geppetto.docs

Repository to host Geppetto documentation
4 stars 9 forks source link

Update documentation #25

Closed tarelli closed 8 years ago

tarelli commented 9 years ago

For users:

For devs:

tarelli commented 9 years ago

@adrianq feel free to add to this!

tarelli commented 9 years ago

@travs how easy/painful is it to move the docs to markdown format like you did for openworm? I don't remember if you used some script or something like that? Thanks!

travs commented 9 years ago

@tarelli I used pandoc and a little shell script, and it wasn't too painful! Check out this and let me know if the instructions aren't totally clear.

The main pain point I found was manually updating relative links, which pandoc didn't seem to do a good job of correcting. There weren't enough to motivate me to automate it, but it wouldn't be too hard to write a script that does it if you have a large number.

tarelli commented 9 years ago

@travs thanks, I'll give it a try!

tarelli commented 9 years ago

@adrianq @gidili please I need help with this, see my fork https://github.com/tarelli/org.geppetto.docs/blob/master/source/usinggeppetto.rst

tarelli commented 8 years ago

Will be updated after the instance type refactoring is complete

LordKrabo commented 8 years ago

I'll keep on working on this for Sprint 75.

LordKrabo commented 8 years ago

Need to add this to sprint 76 I think.

LordKrabo commented 8 years ago

@gidili Are there any other parts of the documentation that you would like me to work on?

LordKrabo commented 8 years ago

Hey @gidili What should I work on for this documentation? More specifically, what parts are you working on currently?