We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.
Already on GitHub?
to your account
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:
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.
Sorry, something went wrong.
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.
Combined approach would be the best. In my opinion.
Hey, check the new (WIP) documentation at http://doc.bionode.io
The repo is bionode/doc.bionode.io and you can just edit the index.html.md file and PR.
Looks cool :)
No branches or pull requests