diff --git a/docs/README.md b/docs/README.md index 8386510b56..ce05077da2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -22,7 +22,7 @@ It is built using the following stack: ## Docs Build Workflow -The docs are built and deployed automatically on GitHub Pages by a [GitHub Action workflow](../.github/workflows/deploy-docs.yml). +The docs are built and deployed automatically on GitHub Pages by a [GitHub Action workflow](../.github/workflows/build-docs.yml). The workflow is triggered on every push to the `main` and `release/v**` branches, every time documentations or specs are modified. ### How It Works @@ -60,7 +60,7 @@ make build-docs When a new major version of the SDK is released, the following steps should be taken: -* On the `release/vX.Y.Z` branch, remove the deploy action (`.github/workflows/deploy-docs.yml`), for avoiding deploying the docs from the release branches. +* On the `release/vX.Y.Z` branch, remove the deploy action (`.github/workflows/build-docs.yml`), for avoiding deploying the docs from the release branches. * On the `release/vX.Y.Z` branch, update `docusaurus.config.js` and set the `lastVersion` to `current`, remove all other versions from the config. * Each time a new version is released (on docusaurus), drop support from the oldest versions. * If the old version is still running vuepress (v0.45, v0.46), remove its line from `vuepress_versions` diff --git a/docs/architecture/adr-033-protobuf-inter-module-comm.md b/docs/architecture/adr-033-protobuf-inter-module-comm.md index 49126f0ef8..68830f879d 100644 --- a/docs/architecture/adr-033-protobuf-inter-module-comm.md +++ b/docs/architecture/adr-033-protobuf-inter-module-comm.md @@ -20,7 +20,7 @@ service definitions defined in [ADR 021](./adr-021-protobuf-query-encoding.md) a ## Context -In the current Cosmos SDK documentation on the [Object-Capability Model](../../docs/learn/advanced/10-ocap.md), it is stated that: +In the current Cosmos SDK documentation on the [Object-Capability Model](../docs/learn/advanced/10-ocap.md), it is stated that: > We assume that a thriving ecosystem of Cosmos SDK modules that are easy to compose into a blockchain application will contain faulty or malicious modules. diff --git a/docs/docs/build/building-apps/01-app-go-di.md b/docs/docs/build/building-apps/01-app-go-di.md index 34b27da511..d425feb858 100644 --- a/docs/docs/build/building-apps/01-app-go-di.md +++ b/docs/docs/build/building-apps/01-app-go-di.md @@ -7,7 +7,7 @@ sidebar_position: 1 :::note Synopsis The Cosmos SDK allows much easier wiring of an `app.go` thanks to [runtime](./00-runtime.md) and app wiring. -Learn more about the rationale of App Wiring in [ADR-057](../architecture/adr-057-app-wiring.md). +Learn more about the rationale of App Wiring in [ADR-057](../../../architecture/adr-057-app-wiring.md). ::: @@ -16,7 +16,7 @@ Learn more about the rationale of App Wiring in [ADR-057](../architecture/adr-05 * [What is `runtime`?](./00-runtime.md) * [Depinject documentation](../packages/01-depinject.md) * [Modules depinject-ready](../building-modules/15-depinject.md) -* [ADR 057: App Wiring](../architecture/adr-057-app-wiring.md) +* [ADR 057: App Wiring](../../../architecture/adr-057-app-wiring.md) ::: diff --git a/docs/docs/build/building-modules/13-upgrade.md b/docs/docs/build/building-modules/13-upgrade.md index 908a6a06ee..20c02e9f2d 100644 --- a/docs/docs/build/building-modules/13-upgrade.md +++ b/docs/docs/build/building-modules/13-upgrade.md @@ -60,4 +60,4 @@ func (m Migrator) Migrate1to2(ctx sdk.Context) error { } ``` -To see example code of changes that were implemented in a migration of balance keys, check out [migrateBalanceKeys](https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-alpha.0/x/bank/migrations/v2/store.go#L55-L76). For context, this code introduced migrations of the bank store that updated addresses to be prefixed by their length in bytes as outlined in [ADR-028](../architecture/adr-028-public-key-addresses.md). +To see example code of changes that were implemented in a migration of balance keys, check out [migrateBalanceKeys](https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-alpha.0/x/bank/migrations/v2/store.go#L55-L76). For context, this code introduced migrations of the bank store that updated addresses to be prefixed by their length in bytes as outlined in [ADR-028](../../../architecture/adr-028-public-key-addresses.md). diff --git a/docs/docs/learn/advanced/00-baseapp.md b/docs/docs/learn/advanced/00-baseapp.md index 4eaf12127d..80b9175002 100644 --- a/docs/docs/learn/advanced/00-baseapp.md +++ b/docs/docs/learn/advanced/00-baseapp.md @@ -166,7 +166,7 @@ which encodes and validates each transaction and from there the `AnteHandler` is If successful, valid transactions are returned inclusive of the events, tags, and data generated during the execution of the proposal. The described behavior is that of the default handler, applications have the flexibility to define their own -[custom mempool handlers](https://docs.cosmos.network/main/building-apps/app-mempool#custom-mempool-handlers). +[custom mempool handlers](https://docs.cosmos.network/main/build/building-apps/app-mempool). ![ProcessProposal](./baseapp_state-prepareproposal.png) @@ -177,7 +177,7 @@ from the root store and is used to process a signed proposal received from a val In this state, `runTx` is called and the `AnteHandler` is executed and the context used in this state is built with information from the header and the main state, including the minimum gas prices, which are also set. Again we want to highlight that the described behavior is that of the default handler and applications have the flexibility to define their own -[custom mempool handlers](https://docs.cosmos.network/main/building-apps/app-mempool#custom-mempool-handlers). +[custom mempool handlers](https://docs.cosmos.network/main/build/building-apps/app-mempool). ![ProcessProposal](./baseapp_state-processproposal.png)