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

Governance: set overview page as index #545

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions src/pages/users/cli/governance/_meta.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
{
"index": "Governance",
"overview": "Governance",
"text": "Text Proposal",
"parameter": "Parameter Change Proposal",
"upgrade": "Software Upgrade Proposal",
"submit": "Submit a Proposal",
"deposit": "Making a Deposit",
"voting": "Voting on a Proposal"
}
}
2 changes: 1 addition & 1 deletion src/pages/users/cli/governance/deposit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Making a Deposit

For a proposal to progress into the voting period, it must meet the minimum
deposit requirement. The min deposit amount is specified [parameters of
governance module](/users/cli/governance/overview/). If the deposit amount is
governance module](/users/cli/governance/). If the deposit amount is
less than the minimum required deposit amount, the proposal will enter the
"deposit period" and will wait for the required amount of tokens to be deposited
within the "max deposit period".
Expand Down
62 changes: 57 additions & 5 deletions src/pages/users/cli/governance/index.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,62 @@
---
title: Governance
pageType: sub-category
---

import { CurrentPageNavigationSections } from "~/components/shared";
import { GovParams } from "~/components/Docs";

<div className="flex flex-col gap-20 sm:gap-[120px]">
<CurrentPageNavigationSections />
</div>
import { Alert } from "~/components/shared";

## Overview

ZetaChain uses the standard Cosmos SDK [`gov` governance
module](https://docs.cosmos.network/v0.50/modules/gov/) to manage the network.
This module allows for the creation of proposals, which can be voted on by
stakers of the network. This guide will walk you through the process of creating
proposals using the ZetaChain's `zetacored` CLI.

## Governance Parameters

<GovParams />

## Making a Proposal

To make a proposal you will need to:

- Create a `proposal.json` file. The contents of the proposal file depends on
the type of a proposal: [text proposal](/users/cli/governance/text),
[parameter change proposal](/users/cli/governance/parameter), [software
upgrade proposal](/users/cli/governance/upgrade), etc.
Comment on lines +25 to +28
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Fix grammatical error in proposal file description.

The subject-verb agreement needs correction.

Apply this diff:

-The contents of the proposal file depends on
+The contents of the proposal file depend on
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- Create a `proposal.json` file. The contents of the proposal file depends on
the type of a proposal: [text proposal](/users/cli/governance/text),
[parameter change proposal](/users/cli/governance/parameter), [software
upgrade proposal](/users/cli/governance/upgrade), etc.
- Create a `proposal.json` file. The contents of the proposal file depends on
+ Create a `proposal.json` file. The contents of the proposal file depend on
the type of a proposal: [text proposal](/users/cli/governance/text),
[parameter change proposal](/users/cli/governance/parameter), [software
upgrade proposal](/users/cli/governance/upgrade), etc.
🧰 Tools
🪛 LanguageTool

[grammar] ~25-~25: Possible subject-verb agreement error.
Context: ...file. The contents of the proposal file depends on the type of a proposal: [text prop...

(NNS_OF_SINGULAR_AGREEMENT)


[grammar] ~26-~26: If ‘type’ is a classification term, ‘a’ is not necessary. Use “type of”. (The phrases ‘kind of’ and ‘sort of’ are informal if they mean ‘to some extent’.)
Context: ...s of the proposal file depends on the type of a proposal: [text proposal](/users/cli/go...

(KIND_OF_A)

- Create and publish a `metadata.json` file to IPFS or the web and submit the
proposal using `zetacored tx gov submit-proposal` command. Learn about this
step on the [Submit a Proposal](/users/cli/governance/submit) page

<Alert variant="tip">
{" "}
Check out the [text proposal](/users/cli/governance/text) doc to learn more about the basics of how proposals are structured.{" "}
</Alert>

## Proposal Stages

The lifecycle of a proposal consists of the following stages:

1. **Deposit Period**: During this period, any user can deposit tokens to a
proposal. If the proposal reaches the required deposit amount, it will move
to the **voting period**. If the proposal does not reach the required deposit
amount, it will be marked as "Rejected". As a creator of a proposal, you can
supply your proposal with the deposit (equal or higher than the min deposit
param) to immediately move to the voting period.
2. **Voting Period**: During this period, stakers can vote on the proposal. If
the proposal does not reach the required quorum or does not pass until the
voting period ends, it will be marked as "Rejected". If the proposal reaches
the required quorum and passes, it will be executed. If the proposal executed
successfully, it will be marked as "Passed". If the proposal executed
unsuccessfully, it will be marked as "Failed".

The deposit amounts will be returned to the depositors, unless the proposal was
vetoed, or never entered voting period (minimum deposit not reached within
deposit period).

## Governance Module Docs

To learn more about the governance module, refer to the [`gov` module
documentation](https://docs.cosmos.network/v0.50/modules/gov/).
62 changes: 0 additions & 62 deletions src/pages/users/cli/governance/overview.mdx

This file was deleted.