cosmos-sdk

cosmos-sdk copied to clipboard

Summary

This issue tracks the pages of the cosmos-sdk documentation for completeness and up-to-dateness checks. Modules are excluded from this tracking issue as their documentations and specs are updated during code change audits (e.g: #11362).

All the docs.cosmos.network documentation must be reviewed as part of the auditing process. (e.g: #11096)

Table of Contents

- Introduction

• High-level Overview
• Application-Specific Blockchains
• Blockchain Architecture
• Main Components of the Cosmos SDK

- Basics

• Anatomy of a Cosmos SDK Application
• Transaction Lifecycle
• Query Lifecycle
• Accounts
• Gas and Fees

- Core Concepts

• BaseApp
• Transactions
• Context
• Middlewares
• Node Client (Daemon)
• Store
• Encoding
• gRPC, REST, and Tendermint Endpoints
• Command-Line Interface
• Events
• Telemetry
• Object-Capability Model
• RunTx recovery middleware
• Cosmos Blockchain Simulator
• Transaction Tips
• In-Place Store Migrations
• Protobuf Documentation

- Building Modules

• Introduction to Cosmos SDK Modules
• Module Manager
• Messages and Queries
• Msg Services
• Query Services
• BeginBlocker and EndBlocker
• Keepers
• Invariants
• Module Genesis
• Module Interfaces
• Recommended Folder Structure
• Errors
• Upgrading Modules
• Module Simulation

- IBC (external link)

- Running a Node, API and CLI

• Setting up the keyring
• Running a Node
• Interacting with the Node
• Generating, Signing and Broadcasting Transactions
• Rosetta
• Running a Testnet
• Cosmosvisor

- Migrations

• Chain Upgrade Guide to v0.44
• REST Endpoints Migration
• Pre-Upgrade Handling

- List of Modules

• As per summary, the module documentation is updated during code change audit

Tasks

• [ ] Verify that upgrade guides (Migrations) are up-to-date
• [ ] Verify all code snippets point to the latest version
• [ ] Verify implementation details still match the latest version
• [ ] Check for and solve dead links

For IBC I would recommend that you remove all content from the SDK docs and you just have a link to redirect the user to ibc-go's own documentation website.

We should check more often https://github.com/cosmos/cosmos-sdk/actions/workflows/linkchecker.yml. Possibly add a slack notification after we fixed all broken links when new links get broken.

Additionally, since the flattening of the module specs, the ToC in the docs are broken (as we split the file). We should have the same vuepress config than osmosis (pre-docusaurus)

I am reviewing all the docs as per https://github.com/cosmos/cosmos-sdk/pull/13471. Closing this.