You are viewing a single comment's thread from:
RE: We Need Proper STEEM API & RPC Documentation Immediately!
I completely agree, @klye. The lack of documentation has been very inconvenient.
From steem's readme:
Code is Documentation
Rather than attempt to describe the rules of the blockchain, it is up to each individual to inspect the code to understand the consensus rules.
It's really supposed to go the other way around: The consensus rules are documented, and the code is supposed to reflect them. How can there be alternative implementations if the protocol is defined solely in terms of the reference implementation?
This is something Steem will eventually need to get past, and it will likely not be a fun process.
It's got to happen so happen sooner than later if STEEM wants to get to it's fullest potential.
Sort of a shame they spent so much time and effort on the platform only to toss us the wheel without instruction and basically let us fend for ourselves.. Have to sort of wonder who thought that was a good idea.
In my opinion proper documentation should be written up as a project evolves so you're not left scrambling at the end or after it's been launched.
This is completely backwards. Even if you are going that way, at least comment the code heavily, so you can autogenerate the docs. :-/
this kind of sucks for those of us who don't know how to code.