Skip to content
New issue

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? Sign in to your account

Add node/protocol developer guide #497

Open
3 of 5 tasks
zhyatt opened this issue Apr 2, 2021 · 2 comments
Open
3 of 5 tasks

Add node/protocol developer guide #497

zhyatt opened this issue Apr 2, 2021 · 2 comments
Assignees

Comments

@zhyatt
Copy link
Contributor

zhyatt commented Apr 2, 2021

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.

@dsiganos
Copy link
Contributor

dsiganos commented Apr 3, 2021

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.

@zhyatt
Copy link
Contributor Author

zhyatt commented Apr 5, 2021

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants