nanocurrency/nano-docs

Add node/protocol developer guide

Opened this issue · 2 comments

We don't have a central spot for developers looking to help with the node/protocol code itself, it is spread out/buried in a few places:

Consider consolidating the "Node Implementation" and "Protocol Design" top-level nav items into the "Living Whitepaper" section (with collapsed sub sections in left nav) could help consolidate them. Then add "Developer Guide" to top-level with expanded contributing details, etc.

If this ticket is primarily due to my feedback, I would like to emphasize that I am not advocating restructuring of existing documentation. I have not read most of the documentation yet and therefore I cannot even begin to consider if it needs restructuring or not.

I am advocating for a "Nano C++ developer quick start guide", which would be supplemental to the existing documentation.
It would focus on being a guide with a beginning and an end, rather than being a reference, and it would focus on the typical issues that a typical newbie C++ nano node developer is likely to encounter.

If this ticket is primarily due to my feedback

Your feedback echoed some other recent questions so there is a bit of a trend it seems. We want to better support external developers and this seems like an easy change to make to provide better discoverability at least.