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

Cardano governance documentation #4719

Merged
merged 1 commit into from
Dec 21, 2022
Merged

Cardano governance documentation #4719

merged 1 commit into from
Dec 21, 2022

Conversation

CarlosLopezDeLara
Copy link
Contributor

This article describes the update proposal mechanism for Byron and Shelley+ eras. Demonstrates how to use the CLI to create update proposals for any era.

Copy link
Contributor

@Jimbo4350 Jimbo4350 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work @CarlosLopezDeLara. Just a couple of comments/changes

doc/reference/cardano-governance.md Outdated Show resolved Hide resolved
doc/reference/cardano-governance.md Outdated Show resolved Hide resolved
doc/reference/cardano-governance.md Outdated Show resolved Hide resolved

The procedure is as follows:

![](../reference/images/upshelley.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Twice in your image you say the update proposal is registered. Should the first instance say the update proposal is submitted and the "registered" after a quorum is reached? I haven't looked at the spec to check this but I noticed the use of "registered" twice.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update proposals can be registered earlier than 6k/f slots to the end of the epoch, or later. The image tries to show the behavior on both scenarios.

Copy link
Contributor

@Jimbo4350 Jimbo4350 Dec 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure but its not clear in the diagram. Preceding with "If the update proposal is registered here" would be clearer as right now is looks like two update proposals are being submitted. Also, I think the diagram is wrong. The blue and purple lines should be interchanged.

Copy link
Contributor Author

@CarlosLopezDeLara CarlosLopezDeLara Dec 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the confusion might come from the term valid (from the spec). Valid does not mean "adopted". Valid means that if the update proposal is registered within the 6k/f slots to the end of the epoch window, its is valid to start accumulating votes during the next epoch.

Perhaps I can split this in two diagrams, one for each case 1) earlier than 6k/f 2) later than 6k/f

Update cardano-governance.md

Update cardano-governance.md

Fix typos.

Update cardano-governance.md

use term Global constant.

Cardano governance doc

This article describes the update proposal mechanism for Byron and Shelley+ eras. Demonstrates how to use the CLI to create update proposals for any era.

Content review, some editing tweaks

cardano governance update doc

* Replace images to mention epoch length = 10k/f
* Mention CIP-59

Update cardano-governance.md

* Include re-delegation workflow
 * Section for  genesis and delegate keys operations
@disassembler disassembler merged commit abeb70b into master Dec 21, 2022
@iohk-bors iohk-bors bot deleted the governance-docs branch December 21, 2022 20:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants