Breakup readme

[charlierudolph]

Thoughts on breaking it up into a documentation folder or a wiki with a page for each function?

[aearly]

I'm thinking of what our goals are for the docs:

• Easily accessible from the readme
• Ctrl+F-able
• Parse-able, so we can support Kapeli and other doc tools Kapeli Dash for Mac #676

A doc folder full of markdown that we build into the readme (or some documentation page we link from the readme) might fit the bill. I'm not really experienced with GH's wiki tools, so I don't know if it supports the Kapeli use case.

[megawac]

I think porting the current docs to jsdoc would offer the best of all worlds (soooooooooo many tools can parse jsdoc)

[aearly]

Where would we put the introductory stuff and common pitfalls in the jsdoc case?

[megawac]

I figure we'd move it to a landing page ala http://danieltao.com/lazy.js/

On Fri, Aug 7, 2015 at 5:22 PM, Alexander Early [email protected]
wrote:

Where would we put the introductory stuff and common pitfalls in the jsdoc
case?

—
Reply to this email directly or view it on GitHub
#859 (comment).

[ecasilla]

I can help port the docs to jsdocs if no one has started yet 😄

[megawac]

If you're interested in helping with that it'd be awesome!
On Oct 13, 2015 6:27 PM, "Ernie Casilla" [email protected] wrote:

I can help port the docs to jsdocs if no one has started yet [image:
😄]

—
Reply to this email directly or view it on GitHub
#859 (comment).

[ecasilla]

I would love to help, but I also don't want to go off into a corner, and implement this all in the dark. I would like the idea of incremental changes. Maybe lets start with a roadmap of how we want to tackle this. It will allow for less friction when it's PR time.

[aearly]

Closing this, we've already moved to JSDoc, and are working on generating the docs site in other issues.