Skip to content
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

Merged
merged 17 commits into from
Nov 13, 2018
Merged

R4R: Docs cleanup #2783

merged 17 commits into from
Nov 13, 2018

Conversation

gamarin2
Copy link
Contributor

Here is the cleanup. It's not perfect, but what's missing is lower priority than other tasks I've been assigned. It's a good basis for future iterations.

@jackzampolin jackzampolin changed the title Docs cleanup WIP: Docs cleanup Nov 12, 2018
@gamarin2 gamarin2 changed the title WIP: Docs cleanup R4R: Docs cleanup Nov 12, 2018
@gamarin2 gamarin2 added T:Docs Changes and features related to documentation. ready-for-review and removed wip labels Nov 12, 2018
@codecov
Copy link

codecov bot commented Nov 12, 2018

Codecov Report

Merging #2783 into docs-overhaul will not change coverage.
The diff coverage is n/a.

@@              Coverage Diff               @@
##           docs-overhaul    #2783   +/-   ##
==============================================
  Coverage          57.89%   57.89%           
==============================================
  Files                129      129           
  Lines               8270     8270           
==============================================
  Hits                4788     4788           
  Misses              3164     3164           
  Partials             318      318

docs/README.md Outdated

### 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dead link

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is the right link here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

none

docs/README.md Outdated

## Use the SDK

The following sections contain the information you need if you want to build a fully-fonctional SDK-based blockchain:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

functional

docs/README.md Outdated

The following sections contain the information you need if you want to build a fully-fonctional SDK-based blockchain:

>*NOTE*: We are currently working on improving the docs. Some info might be missing.
Copy link
Contributor

Choose a reason for hiding this comment

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

docs/README.md Outdated

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).
Copy link
Contributor

@zramsay zramsay Nov 12, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe put in bold: Edit on Github with the link

# Docs Build Workflow
## Updating the docs

If you open a PR on the Cosmos SDK, it is mandatory to update the relevant documentation in `/docs`.
Copy link
Collaborator

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

Copy link
Member

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

::: warning Current Testnet
The current testnet is `gaia-8000`.
:::
The current testnet is `gaia-9001`.
Copy link
Collaborator

@fedekunze fedekunze Nov 12, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚰️ RIP

@@ -1,6 +1,6 @@
# Install the SDK
# Install `gaia`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gaia

@@ -6,7 +6,9 @@ information on the latest testnet, including the correct version
of the Cosmos-SDK to use and details about the genesis file.
:::

Please ensure you have the [Cosmos SDK](/getting-started/installation.md) installed. If you ran a full node on a previous testnet, please skip to [Upgrading From Previous Testnet](#upgrading-from-previous-testnet).
**Please ensure you have the [gaia binaries](/getting-started/installation.md) installed.**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dead link

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what does this need to be updated to?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

./gaia/installation/md

@@ -109,6 +112,8 @@ seeds = "718145d422a823fd2a4e1e36e91b92bb0c4ddf8e@gaia-testnet.coinculture.net:2

If those seeds aren't working, you can find more seeds and persistent peers on the [Cosmos Explorer](https://explorecosmos.network/nodes). Open the the `Full Nodes` pane and select nodes that do not have private (`10.x.x.x`) or [local IP addresses](https://en.wikipedia.org/wiki/Private_network). The `Persistent Peer` field contains the connection string. For best results use 4-6.

You can also ask for peers on the [Validators Riot Room](https://riot.im/app/#/room/#cosmos-validators:matrix.org)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we could add this link to the main docs/REAMDE.md

::: warning Current Testnet
The current testnet is `gaia-8000`.
:::
The current testnet is `gaia-9001`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we need a proper strategy to keep this updated

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can link to the testnets repo in the latest directory...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


The Cosmos Hub holds all of its state in a Merkle store. Updates to
SDK applications hold thri state in a Merkle store. Updates to
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thri ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great usecase for the suggest changes github feature...

@gamarin2 gamarin2 merged commit e0de563 into docs-overhaul Nov 13, 2018
@gamarin2 gamarin2 deleted the gamarin/docs-cleanup branch November 13, 2018 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants