LaconicNetwork/cosmos-sdk
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Fix broken docs links and other small docs improvements (#3218)

Browse Source
This commit is contained in:
gamarin2 2019-01-03 17:08:10 +01:00 committed by Jack Zampolin
parent dbfaa4a514
commit 7ff29246df
4 changed files with 15 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/README.md
View File

@ -1,18 +1,11 @@
# Welcome to the SDK Docs!
# Cosmos SDK Documentation
Welcome to the SDK docs!
## Get Started
## Learn the SDK
- **[SDK Intro](./intro/README.md)**: High-level overview of the Cosmos SDK.
- **[SDK application tutorial](https://github.com/cosmos/sdk-application-tutorial)**: A tutorial to learn the SDK. It showcases how to build an SDK-based blockchain from scratch, and explains the basic principles of the SDK in the process.
### 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.
### Resources
## Resources
- [Specifications](./spec/README.md): Specifications of modules and other parts of the Cosmos SDK.
- [SDK API Reference](https://godoc.org/github.com/cosmos/cosmos-sdk): Godocs of the Cosmos SDK.
@ -20,9 +13,8 @@ If you like to learn by doing, you can follow the **[SDK application tutorial](h
## Cosmos Hub testnet
To install the latest version of the `gaia` application (application of the Cosmos Hub) and join the public testnet, **click [here](./gaia/join-testnet.md)**
To start your own `gaia` testnet, **click [here](./gaia/deploy-testnet.md)**
- [Join the public testnet](./gaia/join-testnet.md) of the Cosmos Hub.
- [Start your own `gaia` testnet](./gaia/deploy-testnet.md).
## Creating a new SDK project

2
docs/gaia/installation.md
View File

@ -42,4 +42,4 @@ $ gaiacli version
### Next
Now you can [join the public testnet](./join-testnet.md) or [create you own private testnet](./private-testnet.md)
Now you can [join the public testnet](./join-testnet.md) or [create you own testnet](./deploy-testnet.md)

2
docs/gaia/join-testnet.md
View File

@ -1,4 +1,4 @@
# Join Public Testnet
# Join the public testnet
::: tip Current Testnet
See the [testnet repo](https://github.com/cosmos/testnets) for

12
docs/gaia/validators/validator-setup.md
View File

@ -1,4 +1,4 @@
# Run a Validator on Public Testnet
# Run a Validator on the public testnet
::: tip
Information on how to join the current testnet (`genesis.json` file and seeds) is held [in our `testnet` repo](https://github.com/cosmos/testnets/tree/master/latest). Please check there if you are looking to join our latest testnet.
@ -6,17 +6,17 @@ Information on how to join the current testnet (`genesis.json` file and seeds) i
__Note__: This documentation is only intended for validators of the **public testnet**
Before setting up your validator node, make sure you've already gone through the [Full Node Setup](/docs/getting-started/full-node.md) guide.
Before setting up your validator node, make sure you've already gone through the [Full Node Setup](../join-testnet.md) guide.
## What is a Validator?
[Validators](/validators/overview.md) are responsible for committing new blocks to the blockchain through voting. A validator's stake is slashed if they become unavailable or sign blocks at the same height. Please read about [Sentry Node Architecture](/validators/validator-faq.md#how-can-validators-protect-themselves-from-denial-of-service-attacks) to protect your node from DDOS attacks and to ensure high-availability.
[Validators](./overview.md) are responsible for committing new blocks to the blockchain through voting. A validator's stake is slashed if they become unavailable or sign blocks at the same height. Please read about [Sentry Node Architecture](./validator-faq.md#how-can-validators-protect-themselves-from-denial-of-service-attacks) to protect your node from DDOS attacks and to ensure high-availability.
::: danger Warning
If you want to become a validator for the Hub's `mainnet`, you should [research security](/validators/security.md).
If you want to become a validator for the Hub's `mainnet`, you should [research security](./security.md).
:::
You may want to skip the next section if you have already [set up a full-node](/join-testnet.md).
You may want to skip the next section if you have already [set up a full-node](../join-testnet.md).
## Create Your Validator
@ -29,7 +29,7 @@ gaiad tendermint show-validator
Next, craft your `gaiad gentx` command:
::: warning Note
Don't use more `STAKE` thank you have! You can always get more by using the [Faucet](https://faucetcosmos.network/)!
Don't use more `STAKE` thank you have! You can always get more by using the [Faucet](https://faucet.cosmos.network/)!
:::
```bash