Skip to content

Commit

Permalink
docs: update documentation to align with v5.0 (#1743)
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanchristo authored Jan 14, 2023
1 parent eab12b8 commit a51d4e6
Show file tree
Hide file tree
Showing 21 changed files with 174 additions and 216 deletions.
45 changes: 27 additions & 18 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -131,9 +131,28 @@ module.exports = {
},
],
},
{
title: 'Data Module',
collapsable: true,
sidebarDepth: 0,
children: [
{
title: 'Overview',
path: '/modules/data/',
},
'/modules/data/01_concepts',
'/modules/data/02_state',
'/modules/data/03_messages',
'/modules/data/04_queries',
'/modules/data/05_events',
'/modules/data/06_types',
'/modules/data/07_client',
'/modules/data/features/',
],
},
{
title: 'Ecocredit Module',
collapsable: false,
collapsable: true,
sidebarDepth: 0,
children: [
{
Expand All @@ -151,22 +170,16 @@ module.exports = {
],
},
{
title: 'Data Module',
collapsable: false,
title: 'Intertx Module',
collapsable: true,
sidebarDepth: 0,
children: [
{
title: 'Overview',
path: '/modules/data/',
path: '/modules/intertx/',
},
'/modules/data/01_concepts',
'/modules/data/02_state',
'/modules/data/03_messages',
'/modules/data/04_queries',
'/modules/data/05_events',
'/modules/data/06_types',
'/modules/data/07_client',
'/modules/data/features/',
'/modules/intertx/01_messages',
'/modules/intertx/02_queries',
],
},
],
Expand Down Expand Up @@ -234,6 +247,7 @@ module.exports = {
'/commands/regen_keys',
'/commands/regen_migrate',
'/commands/regen_query',
'/commands/regen_rollback',
'/commands/regen_rosetta',
'/commands/regen_start',
'/commands/regen_status',
Expand Down Expand Up @@ -315,10 +329,5 @@ module.exports = {
plugins: [
'@vuepress/plugin-back-to-top',
'@vuepress/plugin-medium-zoom',
],
markdown: {
extendMarkdown: md => {
md.use(require('./markdown-it-gh'))
}
}
]
}
48 changes: 0 additions & 48 deletions docs/.vuepress/markdown-it-gh.js

This file was deleted.

3 changes: 2 additions & 1 deletion docs/README_commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,12 @@ The following commands are available using the `regen` binary. The documentation
- [regen keys](regen_keys.md)
- [regen migrate](regen_migrate.md)
- [regen query](regen_query.md)
- [regen rollback](regen_rollback.md)
- [regen rosetta](regen_rosetta.md)
- [regen start](regen_start.md)
- [regen status](regen_status.md)
- [regen tendermint](regen_tendermint.md)
- [regen testnet](regen_testnet.md)
- [regen tx](regen_tx.md)
- [regen validate](regen_validate-genesis.md)
- [regen validate-genesis](regen_validate-genesis.md)
- [regen version](regen_version.md)
36 changes: 20 additions & 16 deletions docs/README_modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,30 @@ Regen Ledger includes native modules built and maintained within the [regen-ledg

## Regen Ledger

- [Ecocredit Module](ecocredit/)
- [Data Module](data/)
- [Ecocredit Module](ecocredit/)
- [Intertx Module](intertx/)

## Cosmos SDK

- [Auth Module](https://docs.cosmos.network/v0.44/modules/auth/)
- [Authz Module](https://docs.cosmos.network/v0.44/modules/authz/)
- [Bank Module](https://docs.cosmos.network/v0.44/modules/bank/)
- [Capability Module](https://docs.cosmos.network/v0.44/modules/capability/)
- [Crisis Module](https://docs.cosmos.network/v0.44/modules/crisis/)
- [Distribution Module](https://docs.cosmos.network/v0.44/modules/distribution/)
- [Evidence Module](https://docs.cosmos.network/v0.44/modules/evidence/)
- [Feegrant Module](https://docs.cosmos.network/v0.44/modules/feegrant/)
- [Mint Module](https://docs.cosmos.network/v0.44/modules/mint/)
- [Params Module](https://docs.cosmos.network/v0.44/modules/params/)
- [Slashing Module](https://docs.cosmos.network/v0.44/modules/slashing/)
- [Staking Module](https://docs.cosmos.network/v0.44/modules/staking/)
- [Upgrade Module](https://docs.cosmos.network/v0.44/modules/upgrade/)
- [Auth Module](https://docs.cosmos.network/v0.46/modules/auth/)
- [Authz Module](https://docs.cosmos.network/v0.46/modules/authz/)
- [Bank Module](https://docs.cosmos.network/v0.46/modules/bank/)
- [Capability Module](https://docs.cosmos.network/v0.46/modules/capability/)
- [Crisis Module](https://docs.cosmos.network/v0.46/modules/crisis/)
- [Distribution Module](https://docs.cosmos.network/v0.46/modules/distribution/)
- [Evidence Module](https://docs.cosmos.network/v0.46/modules/evidence/)
- [Feegrant Module](https://docs.cosmos.network/v0.46/modules/feegrant/)
- [Group Module](https://docs.cosmos.network/v0.46/modules/group/)
- [Mint Module](https://docs.cosmos.network/v0.46/modules/mint/)
- [Params Module](https://docs.cosmos.network/v0.46/modules/params/)
- [Slashing Module](https://docs.cosmos.network/v0.46/modules/slashing/)
- [Staking Module](https://docs.cosmos.network/v0.46/modules/staking/)
- [Upgrade Module](https://docs.cosmos.network/v0.46/modules/upgrade/)

## IBC Go

- [IBC Module](https://ibc.cosmos.network/main/)
- [IBC Transfer Module](https://ibc.cosmos.network/main/)
- [IBC Module](https://ibc.cosmos.network/v5.2.0/)
- [IBC Fee Middleware](https://ibc.cosmos.network/v5.2.0/middleware/ics29-fee/overview.html)
- [IBC Transfer Module](https://ibc.cosmos.network/v5.2.0/apps/transfer/overview.html)
- [ICA Module](https://ibc.cosmos.network/v5.2.0/apps/interchain-accounts/overview.html)
42 changes: 29 additions & 13 deletions docs/ledger/get-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,31 +15,31 @@ Users wanting to interact with [Hambach Testnet](live-networks.md#hambach-testne
Download the zip file:

```bash
curl -LO https://github.com/regen-network/regen-ledger/releases/download/v4.0.0/regen-ledger_4.0.0_darwin_amd64.zip
curl -LO https://github.com/regen-network/regen-ledger/releases/download/v5.0.0/regen-ledger_5.0.0_darwin_amd64.zip
```

Verify the checksum:

```bash
sha256sum regen-ledger_4.0.0_darwin_amd64.zip
sha256sum regen-ledger_5.0.0_darwin_amd64.zip
```

You should see the following:

```bash
19a3e2107d56ef727961f8204acd272fe416794e794697199be6ff11399f9930 regen-ledger_4.0.0_darwin_amd64.zip
26d07f258d489650f0dba059f6d3979f7550bf59514c0ee8f8912cca71bff1c6 regen-ledger_5.0.0_darwin_amd64.zip
```

Unzip the zip file:

```bash
unzip regen-ledger_4.0.0_darwin_amd64.zip
unzip regen-ledger_5.0.0_darwin_amd64.zip
```

Move the binary to your local bin directory:

```bash
sudo mv regen-ledger_4.0.0_darwin_amd64/regen /usr/local/bin
sudo mv regen-ledger_5.0.0_darwin_amd64/regen /usr/local/bin
```

Open a new terminal window and check if the installation was successful:
Expand All @@ -51,39 +51,39 @@ regen version
You should see the following:

```bash
v4.0.0
v5.0.0
```

### For Linux Distributions

Download the zip file:

```bash
curl -LO https://github.com/regen-network/regen-ledger/releases/download/v4.0.0/regen-ledger_4.0.0_linux_amd64.zip
curl -LO https://github.com/regen-network/regen-ledger/releases/download/v5.0.0/regen-ledger_5.0.0_linux_amd64.zip
```

Verify the checksum:

```bash
sha256sum regen-ledger_4.0.0_linux_amd64.zip
sha256sum regen-ledger_5.0.0_linux_amd64.zip
```

You should see the following:

```bash
ca8e6020f2024f4cdb7722f917650a6334ad1f3068a8d14b0dba226bdd5532f0 regen-ledger_4.0.0_linux_amd64.zip
edbf5beaa769f971cf6b6f3c5e45cc3f38ac7d5b9dd005cddc821ccc37771155 regen-ledger_5.0.0_linux_amd64.zip
```

Unzip the zip file:

```bash
unzip regen-ledger_4.0.0_linux_amd64.zip
unzip regen-ledger_5.0.0_linux_amd64.zip
```

Move the binary to your local bin directory:

```bash
sudo mv regen-ledger_4.0.0_linux_amd64/regen /usr/local/bin
sudo mv regen-ledger_5.0.0_linux_amd64/regen /usr/local/bin
```

Check if the installation was successful:
Expand All @@ -95,12 +95,12 @@ regen version
You should see the following:

```bash
v4.0.0
v5.0.0
```

### Other Packages

Additional packages and checksums are available under "Assets" on the [Release Page](https://github.com/regen-network/regen-ledger/releases/tag/v4.0.0).
Additional packages and checksums are available under "Assets" on the [Release Page](https://github.com/regen-network/regen-ledger/releases/tag/v5.0.0).

## Building From Source

Expand Down Expand Up @@ -136,6 +136,14 @@ cd regen-ledger

Check out the latest stable version:

*For the stable app configuration (used on Regen Mainnet and Redwood Testnet):*

```bash
git checkout v5.0.0
```

*For the experimental app configuration (used on Hambach Testnet):*

```bash
git checkout v4.0.0
```
Expand All @@ -162,6 +170,14 @@ regen version

You should see the following:

*For the stable app configuration (used on Regen Mainnet and Redwood Testnet):*

```bash
v5.0.0
```

*For the experimental app configuration (used on Hambach Testnet):*

```bash
v4.0.0
```
3 changes: 2 additions & 1 deletion docs/ledger/migrations/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Migration Overview

The migration guides within this section are written for developers writing applications that consume the Regen Ledger API. The first migration guide is for Regen Ledger v4.0:
The migration guides within this section are written for developers writing applications that consume the Regen Ledger API.

- [Migration Guide v4.0](v4.0-migration.md)
- [Migration Guide v5.0](v5.0-migration.md)

This first page provides an overview of our release process. In addition, we provide some tips on how application developers can stay up to date and prepare ahead of time.

Expand Down
20 changes: 12 additions & 8 deletions docs/tutorials/currency-allowlist-proposal.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,25 @@ Create a `proposal.json` file using the following example (note that the name an

```json
{
"title": "Add $REGEN to the currency allowlist",
"description": "This proposal adds $REGEN to the currency allowlist",
"denom": {
"bank_denom": "uregen",
"display_denom": "regen",
"exponent": 6
"title": "Add $REGEN to the currency allowlist",
"description": "This proposal adds $REGEN to the currency allowlist",
"messages": [
{
"@type": "/regen.ecocredit.marketplace.v1.MsgAddAllowedDenom",
"authority": "regen10d07y265gmmuvt4z0w9aw880jnsr700j9qceqh",
"bank_denom": "uregen",
"display_denom": "regen",
"exponent": 6
}
]
}
```

Each field in the json file is required and should be properly filled out.

Make sure you give the proposal a meaningful title and description. The description should provide a rationale as to why this currency should be added to the list and can be written in either plain text or markdown (see [Proposal #15](https://wallet.keplr.app/chains/regen/proposals/15) for an example of a detailed description).

`denom` includes information about the currency you are proposing to add:
- `authority` is the address of the gov module on Regen Mainnet (you can verify this is the correct address with `regen q auth module-account gov`).

- `bank_denom` is the denom that will be added to the list. In the example above, `uregen` (i.e. "micro regen") is being added. For any denom that is not native to the network, the IBC denom is required (e.g. `ibc/CDC4587874B85BEA4FCEC3CEA5A1195139799A1FEE711A07D972537E18FD`).

Expand All @@ -43,7 +47,7 @@ Keep in mind that non-native tokens represented by an IBC denom only enables a c
Once the json file has been created, you can use the following command to submit the proposal:

```bash
regen tx gov submit-proposal allow-denom-proposal proposal.json --deposit=200000000uregen --from <key-name> --fees <fee-amount>
regen tx gov submit-proposal proposal.json --deposit=200000000uregen --from <key-name> --fees <fee-amount>
```

- `proposal.json` refers to the json file from the previous step, which can be deleted once the proposal has been submitted.
Expand Down
Loading

0 comments on commit a51d4e6

Please sign in to comment.