R4R: Docs cleanup #2783

gamarin2 · 2018-11-12T19:02:32Z

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.

codecov · 2018-11-12T21:17:42Z

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

zramsay · 2018-11-12T22:12:37Z

docs/README.md

+
+### 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.


what is the right link here?

zramsay · 2018-11-12T22:13:12Z

docs/README.md

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


zramsay · 2018-11-12T22:15:51Z

docs/README.md

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


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)

zramsay · 2018-11-12T22:16:55Z

docs/README.md


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


maybe put in bold: Edit on Github with the link

fedekunze · 2018-11-12T22:25:22Z

docs/DOCS_README.md

-# 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`. 


we should add these points to our contribution guidelines as well

Agree. Lets add that to this PR: #2789

Moved this whole section to https://github.com/cosmos/cosmos-sdk/tree/master/CONTRIBUTING.md

fedekunze · 2018-11-12T22:27:28Z

docs/gaia/validators/validator-setup.md

-::: warning Current Testnet
-The current testnet is `gaia-8000`.
+:::
+The current testnet is `gaia-9001`.


zramsay · 2018-11-12T22:31:57Z

docs/gaia/installation.md

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


zramsay · 2018-11-12T22:33:12Z

docs/gaia/join-testnet.md

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


what does this need to be updated to?

./gaia/installation/md

zramsay · 2018-11-12T22:34:25Z

docs/gaia/join-testnet.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)


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

zramsay · 2018-11-12T22:37:31Z

docs/gaia/validators/validator-setup.md

-::: warning Current Testnet
-The current testnet is `gaia-8000`.
+:::
+The current testnet is `gaia-9001`.


we need a proper strategy to keep this updated

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

https://github.com/cosmos/testnets/tree/master/latest

zramsay · 2018-11-12T22:39:09Z

docs/spec/README.md


-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


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

gamarin2 added 14 commits November 9, 2018 15:02

update readme

16f19dc

small fix

f22e96d

add gaia README

c7036d9

refine docs readme

c45514d

little fix

1211d36

workin on cleanup

9694327

^^

3fbcb8d

cleanup specs

6917fae

keep cleanup

5981d70

sdk intro 1/2

d7def17

fix link

ea693ce

fix link bis

d07a9e5

update README

90b05da

better sdk overview 2/2

34834ce

gamarin2 requested review from cwgoes, ebuchman, rigelrozanski and zramsay as code owners November 12, 2018 19:02

jackzampolin added the wip label Nov 12, 2018

jackzampolin changed the title ~~Docs cleanup~~ WIP: Docs cleanup Nov 12, 2018

gamarin2 changed the title ~~WIP: Docs cleanup~~ R4R: Docs cleanup Nov 12, 2018

gamarin2 added T:Docs Changes and features related to documentation. ready-for-review and removed wip labels Nov 12, 2018

Update docs to reflect changes from #2728

40c0350

zramsay reviewed Nov 12, 2018

View reviewed changes

fedekunze reviewed Nov 12, 2018

View reviewed changes

zramsay reviewed Nov 12, 2018

View reviewed changes

docs/gaia/installation.md Outdated

@@ -1,6 +1,6 @@

# Install the SDK

# Install `gaia`

Copy link

Contributor

zramsay Nov 12, 2018

Choose a reason for hiding this comment

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

Gaia

zramsay reviewed Nov 12, 2018

View reviewed changes

zramsay approved these changes Nov 12, 2018

View reviewed changes

jackzampolin and others added 2 commits November 12, 2018 16:52

Address PR comments

664b885

link fix

dfe411b

gamarin2 merged commit e0de563 into docs-overhaul Nov 13, 2018

gamarin2 deleted the gamarin/docs-cleanup branch November 13, 2018 10:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

R4R: Docs cleanup #2783

R4R: Docs cleanup #2783

gamarin2 commented Nov 12, 2018

codecov bot commented Nov 12, 2018 •

edited

Loading

zramsay Nov 12, 2018

jackzampolin Nov 12, 2018

zramsay Nov 13, 2018

zramsay Nov 12, 2018

zramsay Nov 12, 2018

zramsay Nov 12, 2018 •

edited

Loading

fedekunze Nov 12, 2018

jackzampolin Nov 12, 2018

jackzampolin Nov 12, 2018

jackzampolin Nov 13, 2018

fedekunze Nov 12, 2018 •

edited

Loading

zramsay Nov 12, 2018

zramsay Nov 12, 2018

jackzampolin Nov 12, 2018

zramsay Nov 13, 2018

zramsay Nov 12, 2018

zramsay Nov 12, 2018

jackzampolin Nov 12, 2018

jackzampolin Nov 12, 2018

zramsay Nov 12, 2018

jackzampolin Nov 12, 2018


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


		## Use the SDK

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


		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.


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

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


		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

R4R: Docs cleanup #2783

R4R: Docs cleanup #2783

Conversation

gamarin2 commented Nov 12, 2018

codecov bot commented Nov 12, 2018 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zramsay Nov 12, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fedekunze Nov 12, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Nov 12, 2018 •

edited

Loading

zramsay Nov 12, 2018 •

edited

Loading

fedekunze Nov 12, 2018 •

edited

Loading