inline documenation

[elf-pavlik]

@mcollina i can add dox-foundation which you use in your other projects

[mcollina]

I'm not sure.

The doc of all LevelGraph packages is not top notch, so every help in this direction is appreciated.
I would like to adhere to the node-levelup documentation that puts everything inside the README.md file.
All LevelGraph packages are simple enough to offer a narrow API interface, so I think it's feasible.
What do you think?

[elf-pavlik]

I understand your point!

Let's hold on with this one and get back to it after I take care of some issues and get better feel on working with this small piece of code here...

So far both extensions look very simple and I already thought that we may not need to generate documentation. LevelGraph itself looks much more complex and maybe inline documentation could help other people to contribute there little more? Anyhow, topic out of scope for this issue here 😉

[elf-pavlik]

Just thought about using https://github.com/visionmedia/dox and something like https://github.com/aponxi/grunt-readme-generator / https://github.com/assemble/grunt-readme to generate README from inline documentation and test files... not high priority issue but maybe it would offer graceful way of handling documentation.