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

Documentation guides #11

Closed
botanicus opened this issue Jul 5, 2011 · 0 comments
Closed

Documentation guides #11

botanicus opened this issue Jul 5, 2011 · 0 comments

Comments

@botanicus
Copy link

Michael:

"Bunny does not have any documentation guides. The same approach with guides (store them under docs/*, use a DocumentationIndex page for TOC) worked well 3 times already (for amqp, eventmachine and travis-worker). This is also how rubydoc.info expects people to do things (in part because they only let projects use subset of YARD features).

I think amqp gem guides structure can be taken as is, content can be copied where necessary or written anew. I haven't see any attempts for projects to share documentation (code examples, obviously, cannot be shared at all), but having the same set of guides and TOC ordering is certainly possible."

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

No branches or pull requests

2 participants