search

keithwhor / nodal

API Services Made Easy With Node.js
http://www.nodaljs.com/
MIT License
4.51k stars 209 forks source link

Support documentationjs to Nodal Project API reference documentation generation #236

Open nsipplswezey opened 8 years ago

nsipplswezey commented 8 years ago

If Nodal uses the npm documentation package to annotate our source and auto-generate our docs, can we integrate support for JSDoc style source annotation of Nodal projects, and automated API reference building for new Nodal servers?

This would be a cool added dimension to a Nodal project: Source annotation and API reference deployment out-of-the-box. It's one less tooling decision that a developer has to think about when building an API. Then as you build an API, you can build your reference, and release the API with the reference to your end-users from day 1?

The folks managing the npm documentation package seem positive and active, and it's a nice light-weight tool to consider better integrating into a default Nodal project.

keithwhor commented 8 years ago

Yes, we can. I'll see if I can incorporate this into 0.12

keithwhor commented 8 years ago

Didn't land in 0.12. Not the biggest priority heading forward, but would like to get it in a later release.