Skip to content

Commit f6b45e2

Browse files
authored
docs: update README (#3147)
* update README.md * remove warning * remove outdated changes-archive section * fix links * apply review suggestions * update banner * fix link * apply review suggestions * fix links * remove credits from Parameter Changes
1 parent 5de2d40 commit f6b45e2

17 files changed

+48
-1058
lines changed

README.md

+24-94
Original file line numberDiff line numberDiff line change
@@ -11,117 +11,47 @@ developed.](https://img.shields.io/badge/repo%20status-Active-green.svg)](https:
1111
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=cosmos_gaia&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=cosmos_gaia)
1212
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=cosmos_gaia&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=cosmos_gaia)
1313
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=cosmos_gaia&metric=coverage)](https://sonarcloud.io/summary/new_code?id=cosmos_gaia)
14-
[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/cosmosnetwork)
15-
[![Twitter](https://badgen.net/badge/icon/twitter?icon=twitter&label)](https://twitter.com/cosmoshub)
14+
[![Twitter](https://badgen.net/badge/icon/Twitter?icon=twitter&label)](https://x.com/cosmoshub)
15+
[![Discord](https://badgen.net/badge/icon/Discord?icon=discord&label)](https://discord.gg/interchain)
16+
[![Cosmos Hub Forum](https://badgen.net/badge/icon/Cosmos%20Hub%20Forum?icon=atom&label)](https://forum.cosmos.network)
1617

17-
The Cosmos Hub is the first of an exploding number of interconnected blockchains that comprise the Cosmos Network.
18+
The Cosmos Hub is the first of an exploding number of interconnected blockchains that comprise the [Cosmos Network](https://cosmos.network).
1819

19-
<br/>
20-
21-
## 🤔 — Why should you be interested in the Cosmos Hub
22-
23-
___
20+
## 🤔 Why should you be interested in the Cosmos Hub
2421

2522
The Cosmos Hub is built using the [Cosmos SDK](https://github.com/cosmos/cosmos-sdk) and compiled to a binary called `gaiad` (Gaia Daemon). The Cosmos Hub and other fully sovereign Cosmos SDK blockchains interact with one another using a protocol called [IBC](https://github.com/cosmos/ibc) that enables Inter-Blockchain Communication. In order to understand what the Cosmos Hub is you can read this [introductory explanation](https://hub.cosmos.network).
2623

27-
<br/>
28-
29-
## ⚡ — Documentation & Introduction
30-
31-
___
32-
33-
Cosmos Hub is a blockchain network that operates on Proof-of-Stake consensus. You can find an introduction to the Cosmos Hub and how to use the `gaiad` binary as a delegator, validator or node operator as well as how governance on the Cosmos Hub works in the [documentation](https://hub.cosmos.network).
34-
35-
Alternatively, whether you're new to blockchain technology or interested in getting involved, the Cosmos Network [Course](https://tutorials.cosmos.network/academy/0-welcome/) will guide you through everything. The course walks you through the basics of blockchain technology, to staking, setting up your own node, and beyond.
36-
37-
<br/>
38-
39-
## 👤 — Node Operators
40-
41-
___
42-
If you're interested in running a node on the current Cosmos Hub, check out the docs to [Join the Cosmos Hub Mainnet](https://github.com/cosmos/gaia/blob/main/docs/docs/hub-tutorials/join-mainnet.md).
43-
44-
<br/>
45-
46-
## 🗣️ — Validators
47-
48-
___
49-
50-
If you want to participate and help secure Cosmos Hub, check out becoming a validator. Information on what a validator is and how to participate as one can be found at the [Validator FAQ](https://hub.cosmos.network/validators/validator-faq.html#). If you're running a validator node on the Cosmos Hub, reach out to a Janitor on the [Cosmos Developers Discord](https://discord.gg/cosmosnetwork) to join the `#cosmos-hub-validators-verified` channel.
51-
52-
<br/>
53-
54-
## 👥 — Delegators
55-
56-
___
57-
58-
If you still want to participate on the Cosmos Hub, check out becoming a delegator. Information on what a delegator is and how to participate as one can be found at the [Delegator FAQ](https://hub.cosmos.network/delegators/delegator-faq.html).
59-
60-
<br/>
61-
62-
## 👥 — Testnet
63-
64-
___
65-
66-
To participate in or utilize the current Cosmos Hub testnet, take a look at the [cosmos/testnets](https://github.com/cosmos/testnets) repository. This testnet is for the Theta Upgrade expected in Q1 2022. For future upgrades of the Cosmos Hub take a look at the [roadmap](https://github.com/cosmos/gaia/blob/main/docs/docs/roadmap/cosmos-hub-roadmap-2.0.md).
67-
68-
<br/>
69-
70-
## 🌐 — Roadmap
71-
72-
___
73-
74-
For an overview of upcoming changes to the Cosmos Hub take a look at the [Roadmap](https://github.com/cosmos/gaia/blob/main/docs/docs/roadmap/README.md).
75-
76-
<br/>
77-
78-
## 🗄️ — Archives & Genesis
79-
80-
___
81-
82-
With each version of the Cosmos Hub, the chain is restarted from a new Genesis state.
83-
Mainnet is currently running as `cosmoshub-4`. Archives of the state of `cosmoshub-1`, `cosmoshub-2`, and `cosmoshub-3` are available [here](./docs/resources/archives.md).
84-
85-
If you are looking for historical genesis files and other data [`cosmos/mainnet`](http://github.com/cosmos/mainnet) is an excellent resource. Snapshots are also available at [cosmos.quicksync.io](https://cosmos.quicksync.io).
86-
87-
<br/>
88-
89-
## 🤝 — How to contribute
90-
91-
___
24+
## Documentation
9225

93-
Check out [contributing.md](CONTRIBUTING.md) for our guidelines & policies for how we develop the Cosmos Hub. Thank you to all those who have contributed!
26+
For the most up to date documentation please visit [hub.cosmos.network](https://hub.cosmos.network).
9427

95-
<br/>
28+
For an overview of the Interchain Stack (the Cosmos SDK, IBC, etc.), as well as examples and exercises to help developers get a quick start, please visit [tutorials.cosmos.network](https://tutorials.cosmos.network).
9629

97-
## 💬 — Talk to us
30+
### Additional resources
9831

99-
___
32+
**For node operators:** If you're interested in running a node on the current Cosmos Hub, check out the docs to [Join the Cosmos Hub Mainnet](https://hub.cosmos.network/main/hub-tutorials/join-mainnet).
10033

101-
We have active, helpful communities on Twitter, Discord, and Telegram.
34+
**For validators:** If you want to participate and help secure the Cosmos Hub and its [consumer chains](https://hub.cosmos.network/main/interchain-security), consider becoming a validator. Information on what a validator is and how to participate as one can be found at the [Validator FAQ](https://hub.cosmos.network/main/validators/validator-faq). If you're running a validator node on the Cosmos Hub, reach out to a Janitor on the [Cosmos Developers Discord](https://discord.gg/interchain) to join the `#cosmos-hub-validators-verified` channel.
10235

103-
| | |
104-
| -- | -- |
105-
| Cosmos Developers Discord | <a href="https://discord.gg/cosmosnetwork"><img src="https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white" alt="Discord" height="30"/></a> |
106-
| Cosmos Twitter | <a href="https://twitter.com/cosmos"><img src="https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white" alt="Tweet" height="30"/></a> |
107-
| Cosmos Gov Twitter | <a href="https://twitter.com/CosmosGov"><img src="https://img.shields.io/badge/Twitter-FEFEFE?style=for-the-badge&logo=twitter&logoColor=blue" alt="Tweet" height="30"/></a> |
108-
| Cosmos Telegram | <a href="https://t.me/cosmosproject"><img src="https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white" alt="Telegram" height="30"/></a> |
36+
**For delegators:** If you want to secure the Cosmos Hub without running a validator, you can consider becoming a delegator. Information on what a delegator is and how to participate as one can be found at the [Delegator FAQ](https://hub.cosmos.network/main/delegators/delegator-faq).
10937

110-
For updates on the Cosmos Hub team's activities follow us on the [Cosmos Hub Twitter](https://twitter.com/cosmoshub) account.
38+
## Testnet
11139

112-
<br/>
40+
To participate in or utilize the current Cosmos Hub testnet, take a look at the [cosmos/testnets](https://github.com/cosmos/testnets) repository.
11341

114-
## 👏 — Supporters
42+
## Archives & Genesis
11543

116-
___
44+
In the Cosmos Network, chain IDs have a revision number that is incremented on a hard-fork, i.e., when the chain restarts from a new genesis state.
45+
Mainnet is currently running as `cosmoshub-4`.
46+
If you are looking for historical genesis files and other data [`cosmos/mainnet`](http://github.com/cosmos/mainnet) is an excellent resource.
47+
Snapshots are also available at [cosmos.quicksync.io](https://quicksync.io/networks/cosmos.html).
11748

118-
[![Stargazers repo roster for @cosmos/gaia](https://reporoster.com/stars/cosmos/gaia)](https://github.com/cosmos/gaia/stargazers)
119-
[![Forkers repo roster for @cosmos/gaia](https://reporoster.com/forks/cosmos/gaia)](https://github.com/cosmos/gaia/network/members)
49+
## Contributing
12050

121-
<br/>
51+
Check out [CONTRIBUTING.md](CONTRIBUTING.md) for our guidelines & policies for how we develop the Cosmos Hub. Thank you to all those who have contributed!
12252

123-
<p align="center"><a href="https://github.com/nastyox/Rando.js#nastyox"><img src="http://randojs.com/images/barsSmallTransparentBackground.gif" alt="Animated footer bars" width="100%"/></a></p>
53+
## Talk to us
12454

125-
<br/>
55+
Follow the Cosmos Hub team's activities on the [Cosmos Hub Twitter](https://x.com/cosmoshub) account.
12656

127-
<p align="center"><a href="https://github.com/cosmos/gaia#"><img src="http://randojs.com/images/backToTopButtonTransparentBackground.png" alt="Back to top" height="29"/></a></p>
57+
Join the conversation on the [Cosmos Hub Forum](https://forum.cosmos.network) and on [Discord](https://discord.gg/interchain).

docs/docs/delegators/delegator-guide-cli.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This document contains all the necessary information for delegators to interact
77

88
It also contains instructions on how to manage accounts, restore accounts from the fundraiser and use a ledger nano device.
99

10-
:::warning
10+
:::tip
1111
**Very Important**: Please assure that you follow the steps described hereinafter
1212
carefully, as negligence in this significant process could lead to an indefinite
1313
loss of your Atoms. Therefore, read through the following instructions in their
@@ -32,20 +32,28 @@ Please exercise extreme caution!
3232

3333
## Table of Contents
3434

35+
- [Table of Contents](#table-of-contents)
3536
- [Installing `gaiad`](#installing-gaiad)
3637
- [Cosmos Accounts](#cosmos-accounts)
3738
- [Restoring an Account from the Fundraiser](#restoring-an-account-from-the-fundraiser)
39+
- [On a Ledger Device](#on-a-ledger-device)
40+
- [On a Computer](#on-a-computer)
3841
- [Creating an Account](#creating-an-account)
42+
- [Using a Ledger Device](#using-a-ledger-device)
43+
- [Using a Computer](#using-a-computer)
3944
- [Accessing the Cosmos Hub Network](#accessing-the-cosmos-hub-network)
4045
- [Running Your Own Full-Node](#running-your-own-full-node)
4146
- [Connecting to a Remote Full-Node](#connecting-to-a-remote-full-node)
4247
- [Setting Up `gaiad`](#setting-up-gaiad)
4348
- [Querying the State](#querying-the-state)
4449
- [Sending Transactions](#sending-transactions)
4550
- [A Note on Gas and Fees](#a-note-on-gas-and-fees)
51+
- [Sending Tokens](#sending-tokens)
4652
- [Bonding Atoms and Withdrawing Rewards](#bonding-atoms-and-withdrawing-rewards)
47-
- [Participating in Governance](#participating-in-governance)
48-
- [Signing Transactions from an Offline Computer](#signing-transactions-from-an-offline-computer)
53+
- [Participating in Governance](#participating-in-governance)
54+
- [Primer on Governance](#primer-on-governance)
55+
- [In Practice](#in-practice)
56+
- [Signing Transactions From an Offline Computer](#signing-transactions-from-an-offline-computer)
4957

5058
## Installing `gaiad`
5159

docs/docs/governance/README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@ Cosmos governance is driven by the Cosmos community, and much of the documentati
1414
Governance discussions happens in a number of places moderated by diverse community members, including:
1515

1616
- [Forum](http://forum.cosmos.network/)
17-
- [Discord](https://discord.com/invite/cosmosnetwork)
18-
<!-- markdown-link-check-disable-next-line -->
19-
- [Twitter](https://twitter.com/CosmosGov)
17+
- [Discord](https://discord.gg/interchain)
2018
- [Reddit](http://reddit.com/r/cosmosnetwork)
2119
- anywhere else you might interact with members of the Cosmos community!

docs/docs/governance/proposal-types/changes-archive/Auth.mdx

-121
This file was deleted.

0 commit comments

Comments
 (0)