Docco for swagger-node-express

[swagger-api]

Docco for swagger-node-express

[fehguy]

Hi @d1b1 maybe you can tell more about what you're looking to do? Are you looking for sandbox of your api or human (non interactive) documentation?

[d1b1]

@fehguy - We are thinking of something along this lines (http://jashkenas.github.com/docco/). We have found that there are number of background requirements for getting a team or org to build a good API. The swagger UI goes a long way to make this work more transparent for stakeholders outside the team themselvs; managers, support and ops. While we understand the node implementation of the project, we have a feeling there are assumptions in the way the package is written that might be best understood by reading the source code. Since our approach is not unique, it might help there larger community read more verbose docs.

Docco - (written by one of the devs from Backbone.js) helps with this.

[fehguy]

OK, I think you're saying that it'd be helpful to document the swagger module source code with docco, and that docco really doesn't fit into the runtime or swagger system itself, correct? If so, yes, that'd be a great idea, and if you sent a pull request, I'd be happy to merge it in.

[fehguy]

@d1b1 I've started documenting the swagger libs with docco format. Should be pushed in the next day or so.

[fehguy]

Added docs to /docs folder, docco dependency to package.json.