-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2783 from cosmos/gamarin/docs-cleanup
R4R: Docs cleanup
- Loading branch information
Showing
23 changed files
with
422 additions
and
388 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,38 @@ | ||
# Welcome to the Cosmos Docs! | ||
# Welcome to the SDK Docs! | ||
|
||
Welcome to the SDK docs! | ||
|
||
|
||
![cosmonaut reading the cosmos docs in space](./cosmos-docs.jpg) | ||
|
||
Cosmos is a decentralized network of independent parallel blockchains, each powered by classical BFT consensus algorithms like Tendermint. | ||
## Learn the SDK | ||
|
||
### SDK Intro | ||
|
||
If you are a newcomer and would like to learn more about the Cosmos SDK, this **[intro](./intro/README.md)** is a good starting place. | ||
|
||
### SDK tutorial | ||
|
||
If you like to learn by doing, you can follow the **[SDK application tutorial](https://github.com/cosmos/sdk-application-tutorial)**. It showcases how to build an SDK-based blockchain from scratch, and teaches you about the basic principles the SDK in the process. | ||
|
||
The first blockchain in the Cosmos Network is the Cosmos Hub, whose native token is the Atom. Cosmos is a permission-less network, meaning that anybody can build a blockchain on it. | ||
## Use the SDK | ||
|
||
Cosmos can interoperate with multiple other applications and cryptocurrencies. By creating a new zone, you can plug any blockchain system into the Cosmos hub and pass tokens back and forth between those zones, without the need for an intermediary. | ||
The following sections contain the information you need if you want to build a fully-functional SDK-based blockchain: | ||
|
||
## Quick Start | ||
>*NOTE*: We are currently working on improving the docs. Some info might be missing. If that is the case, try the Cosmos [Forum](https://forum.cosmos.network). Failing that, [open an issue](https://github.com/cosmos/cosmos-sdk/issues/new). | ||
- [Getting started with the SDK](./sdk/core/intro.md) | ||
- [SDK Examples](../examples) | ||
- [Join the testnet](./getting-started/join-testnet.md#run-a-full-node) | ||
- [Introduction](./intro/README.md): Contains introductory high-level material on the Cosmos SDK. | ||
- [Gaia](./gaia/README.md): Contains all documentation related to the gaia application (current name for the Cosmos-Hub). | ||
- [Clients](./clients/README.md): Documentation about SDK clients like the SDK Command-Line interface and the SDK Light-client. | ||
- [Specifications](./spec/README.md): Contains SDK and modules specifications. | ||
|
||
If you are reading this on the Cosmos Website, please know that you can find more information on [github](https://github.com/cosmos/cosmos-sdk/tree/develop/docs). Also if you find any issues with the documentation please [*open a Pull Request*](https://github.com/cosmos/cosmos-sdk/compare?expand=1), or at least [*open an Issue*](https://github.com/cosmos/cosmos-sdk/issues/new) to update the docs! | ||
|
||
## Join the public testnet for the Cosmos Hub | ||
|
||
To install the latest version of the `gaia` application and join the public testnet, **click [here](./gaia/README.md#join-the-cosmos-hub-public-testnet)** | ||
|
||
## Edit the Documentation | ||
|
||
See [this file](./DOCS_README.md) for details of the build process and | ||
considerations when making changes. | ||
|
||
## Version | ||
|
||
This documentation is built from the following commit: |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Clients | ||
|
||
This section explains contains information on clients for SDK based blockchain. | ||
|
||
>*NOTE*: This section is a WIP. | ||
## Light-client | ||
|
||
Light-clients enable users to interact with your application without having to download the entire state history but with a good level of security. | ||
|
||
- [Overview of light clients](./lite/README.md) | ||
- [Starting a light-client server](./lite/getting_started.md) | ||
- [Light-client specification](./lite/specification.md) | ||
|
||
## Other clients | ||
|
||
- [Command-Line interface for SDK-based blockchain](./cli.md) | ||
- [Service provider doc](./service-providers.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,3 @@ | ||
# CLI | ||
|
||
See `gaiacli --help` for more details. | ||
|
||
Also see the [testnet | ||
tutorial](https://github.com/cosmos/cosmos-sdk/tree/develop/cmd/gaia/testnets). | ||
|
||
TODO: cleanup the UX and document this properly. | ||
> TODO: Rewrite this section to explain how CLI works for a generic SDK app. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Gaia Documentation | ||
|
||
Welcome to the `Gaia` docs. `Gaia` is the current name of the Cosmos SDK application for the Cosmos Hub. | ||
|
||
## Join the Cosmos Hub public testnet | ||
|
||
- [Install the `gaia` application](./installation.md) | ||
- [Join the current testnet](./join-testnet.md) | ||
- [Upgrade to a validator node](./validators/validator-setup.md) | ||
|
||
## Setup your own `gaia` testnet | ||
|
||
- [Setup your own `gaia` testnet](./networks.md) | ||
|
||
## Additional resources | ||
|
||
- [Intro to validators](./validators/overview.md) | ||
- [Validator FAQ](./validators/validator-faq.md) | ||
- [Validator security considerations](./validators/security.md) |
Oops, something went wrong.