Better docs

[stephentcannon]

Needs better docs in the README.md

People are not always online while coding and cannot read online docs.

Local reference is important.

[queso]

I agree, I actually would like to get something like TomDoc going on. I am a fan of Backbone doc style (using code comments), perhaps I should look at what processor they are using.

[dandv]

👍 (typing this from a crappy GoGoInflight connection)

[ryw]

real issue here is that our docs aren't in our README — @queso didn't we have a solution to both have better README + still have our pretty github.differential.io pages too, from the same source?

[queso]

Yeah, we found one, but it would negatively impact SEO.  I found a new solution in the form of an npm binary that would do some git-fu to sync things up, should find some time to do it.

Either way @danv is right, we need better docs for sure, the README still isn’t enough anymore.

Josh Owens |  Partner at Differential | 513-678-7081 | @joshowens

On June 27, 2014 at 7:43:59 PM, Ry Walker ([email protected]) wrote:

real issue here is that our docs aren't in our README — @queso didn't we have a solution to both have better README + still have our pretty github.differential.io pages too, from the same source?

—
Reply to this email directly or view it on GitHub.

[iambrian7]

The documentation link has 404. How do I separate "label" from field?

OK - I figured out the label field, {{text_field ' name' label= 'Name of Meeting'}}