📝 How can we document the stability upgrade in clear English? #1803
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This looks super wierd with double backticks enclosing almost two sentences worth of text.
Presumably we cannot do an incorrect snapshot the wrong way as a double negative
This was discussed in documentation work at stellar/stellar-docs#1044 (comment)
I would like to specify the block here, see https://discord.com/channels/897514728459468821/948689654977294406/1430102600891760660
discourse on logic at stellar#1735
this part is just for the community, not regulators :)
There's not much precendret for this, but I get the feeling that direct refrences (*liek the stoppp values) oiught display in segments liek this for easier double-checking
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The existing CAP76 doc is extremely technically competent and quite a work of rigor in the limited compilation timeframe. That said, there are some obvious syntax upgrades which help!
I think these pages are more than just "short-lived documents that propose a change" that "are not significantly referenced after implementation and vote." I know from experience these last years working on the docs updates that they can be a source of core information publication. For instance, nowhere else on the internet would we have the direct inflation info on fees burned.
I just started going through things, and I really like the
semanticssection explaining crucial state-archival concepts and functions. I'll polish it up in my free time as quickly as possible these next few busy days for our team. Feel free to use edit access to my repo too.