From 6ddab0dd2bcf337560f09ba450711f1aec805f0e Mon Sep 17 00:00:00 2001 From: Sam Date: Mon, 18 Sep 2023 14:19:56 +0300 Subject: [PATCH] review updates --- docs/build/tooling/README.md | 19 +++++++++ docusaurus.config.js | 8 ++-- .../version-0.47/build/tooling/README.md | 11 ++++++ .../version-0.50/build/packages/README.md | 39 +++++++++++++++++++ .../version-0.50/build/tooling/README.md | 19 +++++++++ 5 files changed, 92 insertions(+), 4 deletions(-) create mode 100644 docs/build/tooling/README.md create mode 100644 versioned_docs/version-0.47/build/tooling/README.md create mode 100644 versioned_docs/version-0.50/build/packages/README.md create mode 100644 versioned_docs/version-0.50/build/tooling/README.md diff --git a/docs/build/tooling/README.md b/docs/build/tooling/README.md new file mode 100644 index 000000000..1fa6ea2cc --- /dev/null +++ b/docs/build/tooling/README.md @@ -0,0 +1,19 @@ +--- +sidebar_position: 0 +--- + +# Tools + +This section provides documentation on various tooling maintained by the SDK team. +This includes tools for development, operating a node, and ease of use of a Cosmos SDK chain. + +## CLI Tools + +* [Cosmovisor](./01-cosmovisor.md) +* [Confix](./02-confix.md) +* [Hubl](./03-hubl.md) +* [Rosetta](https://docs.cosmos.network/main/run-node/rosetta) + +## Other Tools + +* [Protocol Buffers](./00-protobuf.md) \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index d8cc165f4..fcff484ac 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -416,7 +416,7 @@ const config = { }, { from: ["/main/modules/capability", "/main/ecosystem"], - to: "/main/build/modules/auth/", + to: "/main/build/modules/", }, ], }, @@ -451,7 +451,7 @@ function generateRedirects(version) { }, { from: `/${version}/building-modules`, - to: `/${version}/build/building-apps/app-go`, + to: `/${version}/build/building-modules/app-go`, }, { from: `/${version}/modules`, @@ -459,11 +459,11 @@ function generateRedirects(version) { }, { from: `/${version}/packages`, - to: `/${version}/build/packages/depinject`, + to: `/${version}/build/packages`, }, { from: `/${version}/tooling`, - to: `/${version}/build/tooling/cosmovisor`, + to: `/${version}/build/tooling`, }, { from: `/${version}/migrations`, diff --git a/versioned_docs/version-0.47/build/tooling/README.md b/versioned_docs/version-0.47/build/tooling/README.md new file mode 100644 index 000000000..886fed510 --- /dev/null +++ b/versioned_docs/version-0.47/build/tooling/README.md @@ -0,0 +1,11 @@ +--- +sidebar_position: 0 +--- + +# Tools + +This section provides documentation on various tooling used in development of a Cosmos SDK chain, operating a node and testing. + +* [Protocol Buffers](./00-protobuf.md) +* [Cosmovisor](./01-cosmovisor.md) +* [Depinject](./02-depinject.md) \ No newline at end of file diff --git a/versioned_docs/version-0.50/build/packages/README.md b/versioned_docs/version-0.50/build/packages/README.md new file mode 100644 index 000000000..6892dad8e --- /dev/null +++ b/versioned_docs/version-0.50/build/packages/README.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 0 +--- + +# Packages + +The Cosmos SDK is a collection of Go modules. This section provides documentation on various packages that can used when developing a Cosmos SDK chain. +It lists all standalone Go modules that are part of the Cosmos SDK. + +:::tip +For more information on SDK modules, see the [SDK Modules](https://docs.cosmos.network/main/modules) section. +For more information on SDK tooling, see the [Tooling](https://docs.cosmos.network/main/tooling) section. +::: + +## Core + +* [Core](https://pkg.go.dev/cosmossdk.io/core) - Core library defining SDK interfaces ([ADR-063](https://docs.cosmos.network/main/architecture/adr-063-core-module-api)) +* [API](https://pkg.go.dev/cosmossdk.io/api) - API library containing generated SDK Pulsar API +* [Store](https://pkg.go.dev/cosmossdk.io/store) - Implementation of the Cosmos SDK store + +## State Management + +* [Collections](./02-collections.md) - State management library +* [ORM](./03-orm.md) - State management library + +## Automation + +* [Depinject](./01-depinject.md) - Dependency injection framework +* [Client/v2](https://pkg.go.dev/cosmossdk.io/client/v2) - Library powering [AutoCLI](https://docs.cosmos.network/main/core/autocli) + +## Utilities + +* [Log](https://pkg.go.dev/cosmossdk.io/log) - Logging library +* [Errors](https://pkg.go.dev/cosmossdk.io/errors) - Error handling library +* [Math](https://pkg.go.dev/cosmossdk.io/math) - Math library for SDK arithmetic operations + +## Example + +* [SimApp](https://pkg.go.dev/cosmossdk.io/simapp) - SimApp is **the** sample Cosmos SDK chain. This package should not be imported in your application. \ No newline at end of file diff --git a/versioned_docs/version-0.50/build/tooling/README.md b/versioned_docs/version-0.50/build/tooling/README.md new file mode 100644 index 000000000..1fa6ea2cc --- /dev/null +++ b/versioned_docs/version-0.50/build/tooling/README.md @@ -0,0 +1,19 @@ +--- +sidebar_position: 0 +--- + +# Tools + +This section provides documentation on various tooling maintained by the SDK team. +This includes tools for development, operating a node, and ease of use of a Cosmos SDK chain. + +## CLI Tools + +* [Cosmovisor](./01-cosmovisor.md) +* [Confix](./02-confix.md) +* [Hubl](./03-hubl.md) +* [Rosetta](https://docs.cosmos.network/main/run-node/rosetta) + +## Other Tools + +* [Protocol Buffers](./00-protobuf.md) \ No newline at end of file