flatiron/flatiron — Issue #27: Documentation Style / API?
Author: mrienstra
Created: 2012-02-17 01:16:12+00:00
State: open

As mentioned in issue #5, the documentation for Flatiron itself is bit lacking, though the main components seem to have decent documentation coming along.

I was thinking about, say, starting with whatever piece I was trying to learn and adding markdown comments for [Docco](http://jashkenas.github.com/docco/) à la Backbone -- it looks like maybe this is already sort of the convention, but I wanted to check before moving forward.

In general, is there a strategy for documentation / what are the main resource / how to help/ etc.? :)