Skip to content

Commit

Permalink
docs: update README (#3147)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
mpoke authored Jun 17, 2024
1 parent 5de2d40 commit f6b45e2
Show file tree
Hide file tree
Showing 17 changed files with 48 additions and 1,058 deletions.
118 changes: 24 additions & 94 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,117 +11,47 @@ developed.](https://img.shields.io/badge/repo%20status-Active-green.svg)](https:
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=cosmos_gaia&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=cosmos_gaia)
[![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)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=cosmos_gaia&metric=coverage)](https://sonarcloud.io/summary/new_code?id=cosmos_gaia)
[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/cosmosnetwork)
[![Twitter](https://badgen.net/badge/icon/twitter?icon=twitter&label)](https://twitter.com/cosmoshub)
[![Twitter](https://badgen.net/badge/icon/Twitter?icon=twitter&label)](https://x.com/cosmoshub)
[![Discord](https://badgen.net/badge/icon/Discord?icon=discord&label)](https://discord.gg/interchain)
[![Cosmos Hub Forum](https://badgen.net/badge/icon/Cosmos%20Hub%20Forum?icon=atom&label)](https://forum.cosmos.network)

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

<br/>

## 🤔 — Why should you be interested in the Cosmos Hub

___
## 🤔 Why should you be interested in the Cosmos Hub

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).

<br/>

## ⚡ — Documentation & Introduction

___

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).

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.

<br/>

## 👤 — 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://github.com/cosmos/gaia/blob/main/docs/docs/hub-tutorials/join-mainnet.md).

<br/>

## 🗣️ — Validators

___

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.

<br/>

## 👥 — Delegators

___

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).

<br/>

## 👥 — Testnet

___

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).

<br/>

## 🌐 — Roadmap

___

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).

<br/>

## 🗄️ — Archives & Genesis

___

With each version of the Cosmos Hub, the chain is restarted from a new Genesis state.
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).

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).

<br/>

## 🤝 — How to contribute

___
## Documentation

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!
For the most up to date documentation please visit [hub.cosmos.network](https://hub.cosmos.network).

<br/>
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).

## 💬 — Talk to us
### Additional resources

___
**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).

We have active, helpful communities on Twitter, Discord, and Telegram.
**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.

| | |
| -- | -- |
| 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> |
| 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> |
| 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> |
| 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> |
**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).

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

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

## 👏 — Supporters
## Archives & Genesis

___
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.
Mainnet is currently running as `cosmoshub-4`.
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://quicksync.io/networks/cosmos.html).

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

<br/>
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!

<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>
## Talk to us

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

<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>
Join the conversation on the [Cosmos Hub Forum](https://forum.cosmos.network) and on [Discord](https://discord.gg/interchain).
14 changes: 11 additions & 3 deletions docs/docs/delegators/delegator-guide-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This document contains all the necessary information for delegators to interact

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

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

## Table of Contents

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

## Installing `gaiad`

Expand Down
4 changes: 1 addition & 3 deletions docs/docs/governance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ Cosmos governance is driven by the Cosmos community, and much of the documentati
Governance discussions happens in a number of places moderated by diverse community members, including:

- [Forum](http://forum.cosmos.network/)
- [Discord](https://discord.com/invite/cosmosnetwork)
<!-- markdown-link-check-disable-next-line -->
- [Twitter](https://twitter.com/CosmosGov)
- [Discord](https://discord.gg/interchain)
- [Reddit](http://reddit.com/r/cosmosnetwork)
- anywhere else you might interact with members of the Cosmos community!
121 changes: 0 additions & 121 deletions docs/docs/governance/proposal-types/changes-archive/Auth.mdx

This file was deleted.

Loading

0 comments on commit f6b45e2

Please sign in to comment.