Cosmos-sdk: Update documentation for Stargate

[aaronc]

Details of this epic is broken into sub-issues and tracked on Codetree as an epic.

[alexanderbez]

do-not-edit-start-codetree-epic-issues

Issues in this epic:

Title | Milestone | Assignees | State
----- | --------- | --------- | -----
Custom protobuf service code generator #8270 | v0.42 | aaronc, robert-zaremba | Open
Deploy 0.40 docs on "/" #8019 | v0.40 [Stargate] | N/A | Open
[docs]: Update Core Concepts section to Stargate #7661 | v0.40 [Stargate] | amaurymartiny, blushi | Open
[docs]: Stargate docs general audit & cleanup #7659 | v0.40 [Stargate] | amaurymartiny, anilCSE, blushi, clevinson, robert-zaremba | Open
[docs]: update x/staking documentation to stargate #7658 | v0.40 [Stargate] | amaurymartiny | Open
Documentation for cosmovisor #7238 | v0.40 [Stargate] | jgimeno | Open
document how to create a new key type and add it to the keyring #6500 | v0.42 | N/A | Open
Ensure documentation reflects limited SIGN_MODE_DIRECT support for multiple signers & multisig signing #8152 | v0.40 [Stargate] | amaurymartiny, robert-zaremba | Closed
[docs]: client migration guides #7715 | v0.40 [Stargate] | amaurymartiny | Closed
[docs]: Update server/README.md with alternative to simapp.MakeEncodingConfig() #7685 | v0.40 [Stargate] | robert-zaremba | Closed
[docs]: update building modules section to reflect ADR31 #7660 | v0.40 [Stargate] | blushi | Closed
[docs]: New docs section for interacting with a node / update of "Interface" section #7657 | v0.40 [Stargate] | amaurymartiny | Closed
[docs]: Stargate migration guides #7656 | v0.40 [Stargate] | anilCSE | Closed

do-not-edit-end-codetree-epic-issues

All I would add to this is that we have an FAQ with what we expect to be common questions/pitfalls with regards to Protobuf upgrading, tx signing, upgrading, etc..

Also,

updating individual module documentation (x/module/spec)

On this topic, I would prefer that we keep a _single_ README.md in the module root or spec sub-dir as Atlas (Module Registry) will depend on this. Having a single doc with usage, patterns, state behavior, etc... will be crucial for Atlas. This obviously doesn't need to be done for/by Stargate release, but something to keep in mind as we update module documentation.

[marbar3778]

On this topic, I would prefer that we keep a _single_ README.md in the module root or spec sub-dir as Atlas (Module Registry) will depend on this. Having a single doc with usage, patterns, state behavior, etc... will be crucial for Atlas. This obviously doesn't need to be done for/by Stargate release, but something to keep in mind as we update module documentation.

Could this be up to the module author? In the yaml file or however the module gets registered with atlas the author could add a list of docs related to the module and atlas loops through this list?

[amaurymartiny]

A topic we didn't mention yet is i18n. We have cn,kr,ru docs. I propose to keep those docs for /v0.39, but not for /master.

[clevinson]

General question: Lots of docs reference Gaia source code as an example (e.g app.go), should we be redirecting all of these links to Simd?

[anilCSE]

General question: Lots of docs reference Gaia source code as an example (e.g app.go), should we be redirecting all of these links to Simd?

That makes sense

[anilCSE]

@fedekunze you mentioned that you are writing 0.39 -> 0.40 migration docs. Can you reference your PR here if so?

[fedekunze]

hmm I haven't started yet and I wasn't planning to write it on the SDK (just a google doc). I'm waiting to finish cosmos/ethermint#546 first. It's building now but it still needs some fixes

[clevinson]

@fedekunze We'd love to have this incorporated on the docs as well for visibility. If you need help translating them to here we can get someone from the regen team to help, but direct PRs to SDK/docs are welcome!

[amaurymartiny]

Once docs are finished, we should also make the final switch in https://github.com/cosmos/cosmos-sdk/blob/master/docs/versions (and remove the 0.40.x line).