v0.52 Documentation - Githubissues

cosmos / cosmos-sdk

:chains: A Framework for Building High Value Public Blockchains :sparkles:

https://cosmos.network/

Apache License 2.0

6.28k stars 3.64k forks source link

v0.52 Documentation #21429

Open julienrbrt opened 2 months ago

julienrbrt commented 2 months ago

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)
[x] (Build Apps) How to write a system tests (@alpe)
[ ] https://github.com/cosmos/cosmos-sdk/issues/11504
[x] https://github.com/cosmos/cosmos-sdk/issues/7985
[ ] https://github.com/cosmos/cosmos-sdk/issues/13171
[ ] https://github.com/cosmos/cosmos-sdk/issues/1727 (Brief mention of app genesis somewhere)
[ ] https://github.com/cosmos/cosmos-sdk/issues/19729
[ ] (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.
https://github.com/cosmos/cosmos-sdk-docs/issues/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)

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

Build Apps (@julienrbrt, @kocubinski)

Build Modules (@kocubinski, @ziscky, @tac0turtle, @alpe, @julienrbrt)

Modules (Codeowners)

[x] 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
[x] https://docs.cosmos.network/main/build/modules/authz (@akhilkumarpilli)
[x] 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
[x] 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
[x] https://docs.cosmos.network/main/build/modules/gov (@julienrbrt)
[ ] https://docs.cosmos.network/main/build/modules/group
[x] https://docs.cosmos.network/main/build/modules/mint (@lucaslopezf )
[x] https://docs.cosmos.network/main/build/modules/nft (@lucaslopezf )
[ ] https://docs.cosmos.network/main/build/modules/params
[ ] https://docs.cosmos.network/main/build/modules/protocolpool
[x] https://docs.cosmos.network/main/build/modules/slashing (@lucaslopezf )
[x] https://docs.cosmos.network/main/build/modules/staking (@JulianToledano)
[x] https://docs.cosmos.network/main/build/modules/upgrade (@lucaslopezf )
[x] https://docs.cosmos.network/main/build/modules/validate (@julienrbrt)

Learn (@julienrbrt, @JulianToledano, @facundomedica)

[x] https://docs.cosmos.network/main/glossary
[x] https://docs.cosmos.network/main/learn (@JulianToledano)
[ ] https://docs.cosmos.network/main/learn/advanced/autocli (@julienrbrt)
[x] https://docs.cosmos.network/main/learn/advanced/baseapp
[ ] https://docs.cosmos.network/main/learn/advanced/cli
[ ] https://docs.cosmos.network/main/learn/advanced/config
[x] 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
[x] 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
[x] https://docs.cosmos.network/main/learn/advanced/store
[x] https://docs.cosmos.network/main/learn/advanced/telemetry
[x] https://docs.cosmos.network/main/learn/advanced/transactions
[ ] https://docs.cosmos.network/main/learn/advanced/upgrade
[x] https://docs.cosmos.network/main/learn/beginner/accounts (@JulianToledano)
[x] https://docs.cosmos.network/main/learn/beginner/app-anatomy (@JulianToledano)
[x] https://docs.cosmos.network/main/learn/beginner/gas-fees (@JulianToledano)
[x] https://docs.cosmos.network/main/learn/beginner/query-lifecycle (@JulianToledano)
[x] https://docs.cosmos.network/main/learn/beginner/tx-lifecycle (@JulianToledano)
[x] https://docs.cosmos.network/main/learn/intro/overview (@JulianToledano)
[x] https://docs.cosmos.network/main/learn/intro/sdk-app-architecture (@JulianToledano)
[x] https://docs.cosmos.network/main/learn/intro/sdk-design (@JulianToledano)
[x] https://docs.cosmos.network/main/learn/intro/why-app-specific (@JulianToledano)

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

julienrbrt commented 2 months ago

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 commented 2 months ago

Liking https://github.com/cosmos/cosmos-sdk-docs/issues/139 for reference

julienrbrt commented 1 month ago

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