Skip to content

Commit

Permalink
rearranged the OpenGov docs to make the user experience much better
Browse files Browse the repository at this point in the history
  • Loading branch information
gbaci committed Jan 18, 2025
1 parent 639cc02 commit 8900b4e
Show file tree
Hide file tree
Showing 24 changed files with 453 additions and 521 deletions.
55 changes: 55 additions & 0 deletions docs/03_guides/06_governance/01_submit_proposal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: Submit Proposal
---

import useBaseUrl from '@docusaurus/useBaseUrl';

## 00 The Referendum Process

Before proceeding with submitting a proposal to trigger a [referendum](docs/07_governance/02_democracy_referenda.md), identify the right track and origin for it. For example, if the proposal is requesting funds from the treasury, select the treasury track with appropriate spend limits. Read [this post](docs/07_governance/03_democracy_origins_tracks.md) to learn more about Origins and Tracks.

Below is **the ideal process to follow**:

1. **Create a discussion post about your proposal.** This post allows the community to deliberate and recommend improvements.
2. **Create a referenda.**

That said, you are free to create a referenda without first creating a discussion post.

---

## 01 How to Create a Discussion Post

1. Go to **Subsquare > Discussions > New Post**. You can do so following this link: [https://](https://hydradx.subsquare.io/post/create)[hydration.subsquare.io/post/create](https://hydration.subsquare.io/post/create)
2. Fill in the **title, label,** and **description** of your proposal.

<div style={{textAlign: 'center'}}>
<img alt="subsquare_UI_new_discussion_post" src={useBaseUrl('/img/guides/opengov/new_discussion_post.jpg')} width="500px" />
</div>

3. Click **‘Create’** and sign the transaction.

Having created a discussion post for your proposal, you should share the link to the post on community channels and your socials. The goal is to get feedback from the community and also give you an opportunity to address any concerns raised.

---

## 02 How to Create a Proposal

It is advisable to create a discussion around a proposal before making a referendum. This increases your chances of getting your referendum passed as you will get a chance a to listen to and act on community feedback and concerns.

1. Go to **Subsquare > Referenda > New Proposal** https://hydration.subsquare.io/referenda

If you are familiar with creating preimages, then go ahead and choose any of the two main options (New preimage, I already have preimage).

<div style={{textAlign: 'center'}}>
<img alt="subsquare_UI_new_referendum" src={useBaseUrl('/img/guides/opengov/new_referendum.jpg')} width="500px" />
</div>

2. If you do not know how to use preimages, then select one of the **Quick Start** options that best fits your proposal. Below are the options:
1. **Treasury spend local** - for proposals that want to request HDX.
2. **Treasury USDx spend** - for proposals that seek to request USDC/T.
3. **Remark** - for proposals that wish to propose changes to the protocol/ecosystem. most ideal for the ‘Wish for Change’ track.
3. In the following dialog box, enter all relevant details. It is important to specify the correct track for your proposal. Once done, click **‘Create Preimage’** and sign the transaction. This will create your proposal/referendum. But note that until you pay the Decision Deposit, this referendum is, in a sense, inactive since any votes won’t count. At this stage, there are two things you need to do.
4. **Add contextual information**. You can do this by editing the referendum to add the information. Or you can link to the discussion post you created before.
6. **Pay Decision Deposit**. Click the Decision Deposit button on the ’Status’ dialog box of your referendum page. Enter the required HDX and sign the transaction.

At this point, your referendum is now fully created and available for voting.
48 changes: 48 additions & 0 deletions docs/03_guides/06_governance/02_vote_referenda.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: Vote on Referenda
---

import useBaseUrl from '@docusaurus/useBaseUrl';

On this page you will find a **step-by-step guide for voting in Hydration referenda**.

Before proceeding, we encourage you to read the following articles to better understand the intricacies of our OpenGov implementation.

* [Referenda](docs/07_governance/02_democracy_referenda.md)
* [Origins & Tracks](docs/07_governance/03_democracy_origins_tracks.md)
* [Conviction Voting](docs/07_governance/04_democracy_voting.md)


### 00 Navigate to Referendum Page

* Visit the referendum page on **[Subsquare](https://hydration.subsquare.io/referenda)**.
* Click the "**Vote**" button to open the voting dialog.

### 01 Select Your Vote

Choose from one of these voting options:

* **Aye** - vote in favor of the proposal
* **Nay** - vote against the proposal
* **Split** - split your vote between Aye and Nay
* **Abstain** - participate in reaching quorum without taking a position

### 02 Set Vote Amount

Enter the amount of **HDX** you wish to vote with.

### 03 Choose Conviction

* Select your vote's **conviction multiplier**
* Higher conviction means:
* Longer HDX lock period
* Greater voting power
* For more details about conviction voting, read [this post](docs/07_governance/04_democracy_voting.md)

### 04 Submit Vote

* Click "**Confirm**" to submit your vote
* Sign the transaction through your wallet
* Wait for transaction confirmation

To learn more about voting and governance, check out our [OpenGov guides](docs/07_governance).
55 changes: 55 additions & 0 deletions docs/03_guides/06_governance/03_cancel_kill_referenda.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: Cancel or Kill a Referenda
---

import useBaseUrl from '@docusaurus/useBaseUrl';

On this page you will find a **step-by-step guide for cancelling or killing a referendum**.

Before proceeding, we encourage you to read the following articles to better understand the process:

* [Referenda](docs/07_governance/02_democracy_referenda.md)
* [Kill & Cancel](docs/07_governance/06_democracy_cancel_ref.md)

### 00 Access Polkadot-JS UI

* Visit the [Polkadot-JS UI](https://polkadot.js.org/apps/)
* Ensure you are connected to the **Hydration** network:
* Look for the Hydration logo in the top left corner
* If you see a different logo, click it to open the network selector
* Scroll down to Hydration, select a server
* Click 'Switch' to connect

<div style={{textAlign: 'center'}}>
<img alt="subsquare_UI_new_referendum" src={useBaseUrl('/img/guides/opengov/cancel_kill_referenda/polkadot_js.jpg')} width="500px" />
</div>

### 01 Navigate to Referenda

* Go to **Governance > Referenda**
* Click the "**Add Preimage**" button
* Select your account in the **'Send from Account'** dialog

### 02 Configure Proposal

* In the **'Propose'** section, select **'Referenda'**
* Choose your intended action:
* **'cancel(index)'** - Stop the referendum without slashing the decision deposit
* **'kill(index)'** - Stop the referendum and slash the decision deposit

<div style={{textAlign: 'center'}}>
<img alt="subsquare_UI_new_referendum" src={useBaseUrl('/img/guides/opengov/cancel_kill_referenda/submit_preimage.jpg')} width="500px" />
</div>

### 03 Specify Referendum

* Enter the index number of the referendum you wish to cancel/kill
* For example, enter '256' to target **Referendum #256**

### 04 Submit Transaction

* Review your configuration
* Sign the transaction through your wallet
* Wait for transaction confirmation

To learn more about governance processes, check out our [OpenGov guides](docs/07_governance).
14 changes: 14 additions & 0 deletions docs/03_guides/06_governance/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"label": "Governance",
"collapsible": true,
"collapsed": true,
"className": "red",
"link": {
"slug": "/guides/governance",
"type": "generated-index",
"title": "Governance"
},
"customProps": {
"description": ""
}
}
89 changes: 0 additions & 89 deletions docs/03_guides/06_opengov.md

This file was deleted.

Loading

0 comments on commit 8900b4e

Please sign in to comment.