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

Improve governance and staking docs #177

Merged
merged 17 commits into from
Jun 26, 2024
Merged

Conversation

AndreasKendziorra
Copy link
Contributor

What was the problem?

  • Numbers for quorum were wrong.
  • Little mistake in a diagram.
  • Staking and Lisk DAO documentation was missing on overview page.
  • Structure on staking-governance.md and staking.md was not very clean.
  • Documentation about pausing a locking positions was not clear enough.
  • Documentation about voting power snapshotting was missing.

How was it solved?

  • Fixed number for quorum.
  • Updated diagram
  • Improve structure of staking-governance.md and staking.md
  • Rename staking.md to staking-implementation.md
  • Add documentation about pausing
  • Add documentation about voting power snapshotting
  • Add staking and governance to documentation overview

@AndreasKendziorra AndreasKendziorra added the documentation Improvements or additions to documentation label Jun 20, 2024
@AndreasKendziorra AndreasKendziorra self-assigned this Jun 20, 2024
Copy link
Contributor

@gkoumout gkoumout left a comment

Choose a reason for hiding this comment

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

Left a few comments/suggestions

documentation/README.md Outdated Show resolved Hide resolved
documentation/staking-governance.md Outdated Show resolved Hide resolved
documentation/staking-governance.md Show resolved Hide resolved
Copy link
Contributor

@gkoumout gkoumout left a comment

Choose a reason for hiding this comment

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

Looks good! I just made a few minor comments for improvements here and there.

documentation/staking-governance.md Outdated Show resolved Hide resolved
documentation/staking-governance.md Outdated Show resolved Hide resolved
documentation/staking-governance.md Show resolved Hide resolved
documentation/staking-governance.md Outdated Show resolved Hide resolved
documentation/staking-governance.md Outdated Show resolved Hide resolved
documentation/staking-governance.md Outdated Show resolved Hide resolved
Copy link
Contributor

@gkoumout gkoumout left a comment

Choose a reason for hiding this comment

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

Looks good! Just one minor comment, but can be merged from my side.

documentation/staking-governance.md Outdated Show resolved Hide resolved
@AndreasKendziorra AndreasKendziorra force-pushed the improve_governance_and_staking_docs branch from 4d422ea to 4808ef4 Compare June 26, 2024 08:48
@AndreasKendziorra AndreasKendziorra force-pushed the improve_governance_and_staking_docs branch from 4808ef4 to 7a02e52 Compare June 26, 2024 10:16
@shuse2 shuse2 merged commit a8bd414 into main Jun 26, 2024
3 checks passed
@shuse2 shuse2 deleted the improve_governance_and_staking_docs branch June 26, 2024 10:23
sergeyshemyakov pushed a commit that referenced this pull request Jun 28, 2024
* Fix number for quorum

* Fix delegating.png

* Improve "Onchain Governance" section

* Restructure staking.md

* Rename staking.md to staking-implementation.md

* Rename staking.md to staking-implementation.md

* Add section about pausing a locking position

* Add section about voting power for a concrete proposal

* Fix structure of staking-governance.md

* Add Staking and DOA to docs overview page

* Improve formulation about rewards for paused positions

* Fix typo

Co-authored-by: gkoumout <[email protected]>

* Update documentation/staking-governance.md

Co-authored-by: gkoumout <[email protected]>

* Improve voting power section

* Emphasize some words in locking mechanism section

* Apply suggestions

* Apply suggestions

---------

Co-authored-by: gkoumout <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants