-
Notifications
You must be signed in to change notification settings - Fork 3.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
R4R: Docs cleanup #2783
R4R: Docs cleanup #2783
Changes from 15 commits
16f19dc
f22e96d
c7036d9
c45514d
1211d36
9694327
3fbcb8d
6917fae
5981d70
d7def17
ea693ce
d07a9e5
90b05da
34834ce
40c0350
664b885
dfe411b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,40 @@ | ||
# 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](./sdk.md)** is a good starting place. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. dead link There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. what is the right link here? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. none |
||
|
||
### 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. | ||
|
||
## Use the SDK | ||
|
||
The following sections contain the information you need if you want to build a fully-fonctional SDK-based blockchain: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. functional |
||
|
||
>*NOTE*: We are currently working on improving the docs. Some info might be missing. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. i would remove this and link to either the forum (e.g., for clarification) or issues (for outright wrong stuff or request for missing information) |
||
|
||
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. | ||
- [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. | ||
|
||
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. | ||
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). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. maybe put in bold: |
||
|
||
## Quick Start | ||
## Join the public testnet for the Cosmos Hub | ||
|
||
- [Getting started with the SDK](./sdk/core/intro.md) | ||
- [SDK Examples](../examples) | ||
- [Join the testnet](./getting-started/join-testnet.md#run-a-full-node) | ||
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: |
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) |
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 was deleted.
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) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we should add these points to our contribution guidelines as well
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree. Lets add that to this PR: #2789
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Moved this whole section to https://github.com/cosmos/cosmos-sdk/tree/master/CONTRIBUTING.md