Skip to content

Commit e1c202d

Browse files
committed
Add links, use consistent variable naming convention & other fixes
1 parent eebb9fd commit e1c202d

3 files changed

Lines changed: 23 additions & 20 deletions

File tree

SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
* [Manage accounts](docs/cheqd-cli/cheqd-cli-accounts.md)
1616
* [Manage a node](docs/cheqd-cli/cheqd-cli-node-management.md)
1717
* [Make transactions](docs/cheqd-cli/cheqd-cli-token-transactions.md)
18+
* [Draft governance proposals](docs/cheqd-cli/cheqd-cli-gov-proposals.md)
1819
* [Use fee abstraction](docs/cheqd-cli/cheqd-cli-fee-abstraction.md)
1920

2021
## 🏦 Validator Guides

docs/cheqd-cli/cheqd-cli-gov-proposals-types.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@ cheqd-noded tx gov submit-proposal [path/to/proposal.json]
3232
{
3333
"metadata": "ipfs://CID",
3434
"deposit": "8000000000000ncheq",
35-
"title": "<proposal-title>",
36-
"summary": "<proposal-description>",
35+
"title": "<proposal_title>",
36+
"summary": "<proposal_description>",
3737
"expedited": false
3838
}
3939
```
4040

4141
The main parameters here are:
4242

43-
- `proposal-title` - name of the proposal.
43+
- `proposal_title` - name of the proposal.
4444
- `proposal_description` - proposal description; limited to 255 characters; you can use json markdown to provide links.
4545

4646
### 2) Community Pool Spend
@@ -51,7 +51,7 @@ The main parameters here are:
5151
{
5252
"@type": "/cosmos.distribution.v1beta1.MsgCommunityPoolSpend",
5353
"authority": "cheqd10d07y265gmmuvt4z0w9aw880jnsr700j5ql9az",
54-
"recipient": "<recipient-address>",
54+
"recipient": "<recipient_address>",
5555
"amount": [
5656
{
5757
"denom": "ncheq",
@@ -62,17 +62,17 @@ The main parameters here are:
6262
],
6363
"metadata": "ipfs://CID",
6464
"deposit": "8000000000000ncheq",
65-
"title": "<proposal-title>",
66-
"summary": "<proposal-description>",
65+
"title": "<proposal_title>",
66+
"summary": "<proposal_description>",
6767
"expedited": false
6868
}
6969
```
7070

7171
The main parameters here are:
7272

73-
- `proposal-title` - name of the proposal.
73+
- `proposal_title` - name of the proposal.
7474
- `proposal_description` - proposal description; limited to 255 characters; you can use json markdown to provide links.
75-
- `recipient-address`- cheqd address to which the community pool tokens should be sent.
75+
- `recipient_address`- cheqd address to which the community pool tokens should be sent.
7676
- `amount` - amount of tokens to be sent to the recipient address.
7777

7878
### 3) Software upgrade
@@ -94,15 +94,15 @@ The main parameters here are:
9494
],
9595
"metadata": "ipfs://CID",
9696
"deposit": "8000000000000ncheq",
97-
"title": "<proposal-title>",
97+
"title": "<proposal_title>",
9898
"summary": "<proposal_description>",
9999
"expedited": false
100100
}
101101
```
102102

103103
The main parameters here are:
104104

105-
- `proposal-title` - name of the proposal.
105+
- `proposal_title` - name of the proposal.
106106
- `proposal_name` - name of proposal which will be used in `UpgradeHandler` in the new application,
107107
- `proposal_description` - proposal description; limited to 255 characters; you can use json markdown to provide links.
108108
- `upgrade_height` - height when upgrade process will be triggered. Keep in mind that this needs to be after voting period has ended.
@@ -117,26 +117,26 @@ The main parameters here are:
117117
"messages": [
118118
{
119119
"@type": "/ibc.core.client.v1.MsgRecoverClient",
120-
"subject_client_id": "<expired-client-id>",
121-
"substitute_client_id": "<new-client-id>",
122-
"signer": "prop-submitter-address>"
120+
"subject_client_id": "<expired_client-id>",
121+
"substitute_client_id": "<new_client-id>",
122+
"signer": "prop_submitter_address>"
123123
}
124124
],
125125
"metadata": "ipfs://CID",
126126
"deposit": "8000000000000ncheq",
127-
"title": "<proposal-title>",
127+
"title": "<proposal_title>",
128128
"summary": "<proposal_description>",
129129
"expedited": false
130130
}
131131
```
132132

133133
The main parameters here are:
134134

135-
- `proposal-title` - name of the proposal.
135+
- `proposal_title` - name of the proposal.
136136
- `proposal_description` - proposal description; limited to 255 characters; you can use json markdown to provide links.
137-
- `expired-client-id` - IBC client id of the expired connection.
138-
- `new-client-id` - IBC client id of the replacement connection.
139-
- `prop-submitter-address` - Cheqd address of the user who will submit the proposal.
137+
- `expired_client_id` - IBC client id of the expired connection.
138+
- `new_client_id` - IBC client id of the replacement connection.
139+
- `prop_submitter_address` - Cheqd address of the user who will submit the proposal.
140140

141141
## Expedited Proposals
142142

@@ -150,8 +150,8 @@ Any and all proposals can be submitted as expedited proposals by switching the `
150150
{
151151
"metadata": "ipfs://CID",
152152
"deposit": "8000000000000ncheq",
153-
"title": "<proposal-title>",
154-
"summary": "<proposal-description>",
153+
"title": "<proposal_title>",
154+
"summary": "<proposal_description>",
155155
"expedited": true
156156
}
157157
```

docs/upgrades/propose-software-upgrade.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,8 @@ The main parameters here are:
6868
- `operator_alias` - alias of a key which will be used for signing proposal,
6969
- `<chain_id>` - identifier of chain which will be used while creating the blockchain.
7070

71+
Follow our [guide for drafting governance proposal](../cheqd-cli/cheqd-cli-gov-proposals-types.md) if you need help with creating the proposal file.
72+
7173
In case of successful submitting the next command can be used for getting `proposal_id`:
7274

7375
```bash

0 commit comments

Comments
 (0)