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
Use Ronn to create man pages from MarkDown Documentation #52
Comments
I don't think this issue is entirely relevant anymore. I'm going to close it. I do, however, think that discussing an overall documentation strategy is worthwhile. |
Do you mean that there should be new markdown files containing the Ronn documentation, in addition to the in-code markdown comments, or should this come straight from the in-code markdown comments? In the case that new markdown files should be created, I think that there could be a |
(well, i couldn't call the folder docs, that's already taken by the doccu stuff...) |
This isn't relevant to our documentation process any longer. Between the handbook and jitsu's readme I believe changing the process to use ronn is late in the game now. |
We should create better MarkDown documentation and then split it into sections that http://rtomayko.github.com/ronn/ can easily consume to create man pages.
We can then use these MD files to help auto-generate the ReadME.md file
The text was updated successfully, but these errors were encountered: