Documentation / Tutorial / API reference

[paneq]

http://documentup.com/perplexes/m2r http://www.rubydoc.info/github/perplexes/m2r/

Document private / public classes in API.

Which tool should we use for documentation: http://warpspire.com/talks/documentation/ ?

The documentation should be considered from 2 points:

• A person who needs to use m2r to run rack application. Probably Ruby on Rails or Sinatra.
• A person interested in writing simple (or complicated) handler for mongrel2 that has nothing to do with rack whatsoever.

[paneq]

http://thechangelog.com/post/3032074343/top-ten-reasons-why-i-wont-use-your-open-source-project

[paneq]

http://gnuu.org/2010/05/12/whats-missing-from-tomdoc/ https://github.com/rubyworks/yard-tomdoc/issues/8 https://github.com/rubyworks/yard-tomdoc/issues/7

Documenting first method revealed issues with tomdoc so I am going to stick with YARD and fix that documentation.

[paneq]

Great documentation is very hard to pull off. To even have good documentation you need to meet three major needs.

• Introduction - New users should be able to dive-in and start using your product with a gentle tutorial right away.
• Exposure - Current users should be able to discover new features they might not know about.
• Reference - Veteran users should be able to easily find particular pages by name.

from http://calv.info/what-10gen-nailed-with-mongodb/

[paneq]

@pawelpacana I documented almost everything. Could you take a look ? Here are my doubts for the rest of the stuff:

• Rack::Handler::Mongrel2 - I am not comfortable with making this part of API public yet. I expect things to change hear in near future.
• M2R::RackHandler - same here.