Improve global documentation generation and layout #27
Comments
I really like literate coding with docco that automatically generate docs from code comments, but maybe we should switch to a more user friendly docs with Slate. |
I also like the docs alongside code, but it makes it more difficult to quickly scan. Looks like slate might be more for REST API documentation? For bionode-quickgo I used jsdoc2md. I think if we use jsdoc there are many options available for generated html/markdown from that. |
Docs which should be in code and docs which should be outside of code always present in any project. |
Hey, check the new (WIP) documentation at http://doc.bionode.io |
Looks cool :) |
The global docs at doc.bionode.io result from the concatenation of all the docco generated html files of each module (e.g., bionode-ncbi docs). We should improve the layout to aim at something similar to the underscore documentation while still keeping it automatic.
The text was updated successfully, but these errors were encountered: