v0.52 Documentation

[julienrbrt]

Once the audit is completed and integration is started, we should update the documentation to match v0.52.
Once this issue is closed, we can update cosmos/cosmos-sdk-docs to create the https://docs.cosmos.network/v052 docs.

Tasks to take for the docs focus week:

NB:

• Make your editor follow the repo markdown rules: https://github.com/cosmos/cosmos-sdk/blob/main/.markdownlint.json
• Doc changes need to be made in this repo (not cosmos-sdk-docs) and backported to release/v0.52.x
• Verify the cohesion and the language is consistent with the other pages

New content

• (Build modules) Description of app module environment
• (Build modules) Introduction to core and core services (focus in v0.52 and not v2)
• (Build Apps) How to write a system tests (@alpe)
• Update Upgrade documentation and guides #11504
• Document best practices for data serialization #7985
• SDK Gotcha Doc #13171
• Genesis Documentation  #1727 (Brief mention of app genesis somewhere)
• (accounts) How to use base accounts, multisig accounts and lockup accounts. (@testinginprod, @sontrinh16, @facundomedica)

Content to rewrite

• Baseapp architecture
• deprecation of sdk.Context + for core
• Module manager architecture
• Check ADRs and verify their Status is correct.
• [Epic]: Documentation Revise Cycle cosmos-sdk-docs#139

Content to remove

• Remove or deprecated baseapp / sdk.Context page

Content to update

• Code owners should take their components and the rest will be split in the team.
• For the rest, we should just look at the sitemap (https://docs.cosmos.network/sitemap.xml), and assign each of us multiple pages.

Sitemap Pages to Update

Build (@lucaslopezf, @cool-develope, @hieuvubk, @julienrbrt)

• https://docs.cosmos.network/main/build/abci/introduction (@hieuvubk)
• https://docs.cosmos.network/main/build/abci/prepare-proposal (@hieuvubk)
• https://docs.cosmos.network/main/build/abci/process-proposal (@hieuvubk)
• https://docs.cosmos.network/main/build/abci/vote-extensions (@hieuvubk)
• https://docs.cosmos.network/main/build/migrations/intro (@julienrbrt)
• https://docs.cosmos.network/main/build/migrations/upgrading (@julienrbrt)
• https://docs.cosmos.network/main/build/packages (@julienrbrt)
• https://docs.cosmos.network/main/build/packages/collections
• https://docs.cosmos.network/main/build/packages/depinject
• https://docs.cosmos.network/main/build/packages/orm
• https://docs.cosmos.network/main/build/tooling (@julienrbrt)
• https://docs.cosmos.network/main/build/tooling/autocli (@julienrbrt)
• https://docs.cosmos.network/main/build/tooling/confix (@julienrbrt)
• https://docs.cosmos.network/main/build/tooling/cosmovisor (@julienrbrt)
• https://docs.cosmos.network/main/build/tooling/hubl (@julienrbrt)
• https://docs.cosmos.network/main/build/tooling/protobuf (@julienrbrt)

Build Apps (@julienrbrt, @kocubinski)

• https://docs.cosmos.network/main/build/building-apps/app-go
• https://docs.cosmos.network/main/build/building-apps/app-go-di
• https://docs.cosmos.network/main/build/building-apps/app-mempool
• https://docs.cosmos.network/main/build/building-apps/app-testnet
• https://docs.cosmos.network/main/build/building-apps/app-upgrade
• https://docs.cosmos.network/main/build/building-apps/security-part-1

Build Modules (@julienrbrt)

• https://docs.cosmos.network/main/build/building-modules/beginblock-endblock
• https://docs.cosmos.network/main/build/building-modules/depinject
• https://docs.cosmos.network/main/build/building-modules/errors
• https://docs.cosmos.network/main/build/building-modules/genesis
• https://docs.cosmos.network/main/build/building-modules/intro
• https://docs.cosmos.network/main/build/building-modules/invariants)
• https://docs.cosmos.network/main/build/building-modules/keeper
• https://docs.cosmos.network/main/build/building-modules/messages-and-queries
• https://docs.cosmos.network/main/build/building-modules/module-interfaces
• https://docs.cosmos.network/main/build/building-modules/module-manager
• https://docs.cosmos.network/main/build/building-modules/msg-services
• https://docs.cosmos.network/main/build/building-modules/preblock
• https://docs.cosmos.network/main/build/building-modules/protobuf-annotations
• https://docs.cosmos.network/main/build/building-modules/query-services
• https://docs.cosmos.network/main/build/building-modules/simulator
• https://docs.cosmos.network/main/build/building-modules/structure
• https://docs.cosmos.network/main/build/building-modules/testing
• https://docs.cosmos.network/main/build/building-modules/upgrade

Modules (Codeowners)

• https://docs.cosmos.network/main/build/modules
• https://docs.cosmos.network/main/build/modules/accounts
• https://docs.cosmos.network/main/build/modules/auth
• https://docs.cosmos.network/main/build/modules/auth/tx
• https://docs.cosmos.network/main/build/modules/auth/vesting
• https://docs.cosmos.network/main/build/modules/authz (@akhilkumarpilli)
• https://docs.cosmos.network/main/build/modules/bank (@sontrinh16)
• https://docs.cosmos.network/main/build/modules/circuit
• https://docs.cosmos.network/main/build/modules/consensus
• https://docs.cosmos.network/main/build/modules/counter
• https://docs.cosmos.network/main/build/modules/crisis
• https://docs.cosmos.network/main/build/modules/distribution (@JulianToledano)
• https://docs.cosmos.network/main/build/modules/epochs
• https://docs.cosmos.network/main/build/modules/evidence
• https://docs.cosmos.network/main/build/modules/feegrant
• https://docs.cosmos.network/main/build/modules/genutil
• https://docs.cosmos.network/main/build/modules/gov (@julienrbrt)
• https://docs.cosmos.network/main/build/modules/group
• https://docs.cosmos.network/main/build/modules/mint (@lucaslopezf )
• https://docs.cosmos.network/main/build/modules/nft (@lucaslopezf )
• https://docs.cosmos.network/main/build/modules/params
• [Documentation]: protocol pool  #19729
• https://docs.cosmos.network/main/build/modules/slashing (@lucaslopezf )
• https://docs.cosmos.network/main/build/modules/staking (@JulianToledano)
• https://docs.cosmos.network/main/build/modules/upgrade (@lucaslopezf )
• https://docs.cosmos.network/main/build/modules/validate (@julienrbrt)

Learn (@julienrbrt, @JulianToledano, @facundomedica)

• https://docs.cosmos.network/main/glossary
• https://docs.cosmos.network/main/learn (@JulianToledano)
• https://docs.cosmos.network/main/learn/advanced/autocli (@julienrbrt)
• https://docs.cosmos.network/main/learn/advanced/baseapp
• https://docs.cosmos.network/main/learn/advanced/cli
• https://docs.cosmos.network/main/learn/advanced/config
• https://docs.cosmos.network/main/learn/advanced/context
• https://docs.cosmos.network/main/learn/advanced/encoding
• https://docs.cosmos.network/main/learn/advanced/events
• https://docs.cosmos.network/main/learn/advanced/grpc_rest
• https://docs.cosmos.network/main/learn/advanced/node
• https://docs.cosmos.network/main/learn/advanced/ocap (@julienrbrt)
• https://docs.cosmos.network/main/learn/advanced/proto-docs
• https://docs.cosmos.network/main/learn/advanced/runtx_middleware
• https://docs.cosmos.network/main/learn/advanced/simulation
• https://docs.cosmos.network/main/learn/advanced/store
• https://docs.cosmos.network/main/learn/advanced/telemetry
• https://docs.cosmos.network/main/learn/advanced/transactions
• https://docs.cosmos.network/main/learn/advanced/upgrade
• https://docs.cosmos.network/main/learn/beginner/accounts (@JulianToledano)
• https://docs.cosmos.network/main/learn/beginner/app-anatomy (@JulianToledano)
• https://docs.cosmos.network/main/learn/beginner/gas-fees (@JulianToledano)
• https://docs.cosmos.network/main/learn/beginner/query-lifecycle (@JulianToledano)
• https://docs.cosmos.network/main/learn/beginner/tx-lifecycle (@JulianToledano)
• https://docs.cosmos.network/main/learn/intro/overview (@JulianToledano)
• https://docs.cosmos.network/main/learn/intro/sdk-app-architecture (@JulianToledano)
• https://docs.cosmos.network/main/learn/intro/sdk-design (@JulianToledano)
• https://docs.cosmos.network/main/learn/intro/why-app-specific (@JulianToledano)

---

Additionally, we need to think about where to include v2 documentation.

[julienrbrt]

I have written the first guide here: https://hackmd.io/@julienrbrt/S16-_Vq50
I'll wait until core v1 alpha to link code snippets in there

[julienrbrt]

Liking cosmos/cosmos-sdk-docs#139 for reference

[julienrbrt]

Docs are deployed https://docs.cosmos.network/v0.52

[julienrbrt]

v0.52 is very close. Going to take over the whole issue next week and just push it through!