Dev Docs: "Not A Specification" #679
Conversation
| likely provide consensus code that is more complete, more portable, and | ||
| more consistent in diverse environments. | ||
|
|
||
| In addition, we also warn you that this documentation has not been |
There was a problem hiding this comment.
Maybe instead the always-visible disclaimer could be updated to be a bit more explicit that the documentation likely still contains many errors (and the "has been written recently" part may not be accurate anymore)?
There was a problem hiding this comment.
Good idea. I'll put updating that disclaimer in a separate pull. Thanks!
|
@harding As far as I'm concerned, LGTM, thanks! |
|
@saivann thanks for your review! I think all feedback has been addressed: commit de7d371 changes the "majority" phrasing, I tagged all the old dev docs issues so the past issues link demonstrates the doc's fallibility, and opened pull #680 to update the disclaimer. Thanks again! |
Make explicit that the docs are not a specification and never will be.
|
Rebased and added the new subhead links to the Not A Specification subsection. In the absence of critical feedback, I'll merge this around 13:00 UTC Thursday (48 hours from now). Additional reviews, even after the merge, are always appreciated. |
Preview: http://dg0.dtrt.org/en/developer-reference#not-a-specification
Make explicit that the docs are not a specification and never will be:
This is inspired by @gmaxwell's recent BitcoinTalk post about protocol standardization. @gmaxwell: I'd appreciate it if you could review the new section preview linked above; it's only 5 short paragraphs.