📝 How can we document the stability upgrade in clear English? #1803
Conversation
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
|
Speaking of clear English, awesome job @briwylde08 on the release article! Super clear narrative that hit straight to the point in posts that took urgency and data specifics responsibly. 💜 Wording on the last paragraph in particular was inspiration in writing these changes. Speaking of, is there a canonical point of reference for the English-world names of protocol versions? |
|
@JFWooten4 I didn't actually write that one but I'm sure whoever did appreciates the comments! As for where the English-world names are, do you mean something like this? https://stellar.org/protocol-upgrades |
|
So weird, I could've sworn I saw your name on one of the release articles, Bri! Lol, well of course either way and appreciate the clarification. I agree that looks like a great place for the reference presuming we don't want it controlled by a community open-source repo, which I think is totally OK. But still not seeing a name for P24, which I noticed took a second blog post to affirm last protocol—separate from the upgrade guide. Are we going to have public discussions about these diction choices going forward? Also what's the reviewer process look like to get these and other syntax changes merged into |
|
This pull request is stale because it has been open for 30 days with no activity. It will be closed in 30 days unless the stale label is removed. |
2 participants
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.