diff --git a/docs/architecture/README.md b/docs/architecture/README.md index fd3a3b1e0e..f14ab2e4f2 100644 --- a/docs/architecture/README.md +++ b/docs/architecture/README.md @@ -86,9 +86,6 @@ When writing ADRs, follow the same best practices for writing RFCs. When writing * [ADR 062: Collections State Layer](./adr-062-collections-state-layer.md) * [ADR 063: Core Module API](./adr-063-core-module-api.md) * [ADR 065: Store V2](./adr-065-store-v2.md) -* [ADR 067: Simulator v2](./adr-067-simulator-v2.md) -* [ADR 069: `x/gov` modularity, multiple choice and optimisic proposals](./adr-069-gov-improvements.md) -* [ADR 074: Messages with implicit signers](./adr-074-implicit-msg-signers.md) * [ADR 076: Transaction Malleability Risk Review and Recommendations](./adr-076-tx-malleability.md) ### Draft diff --git a/docs/docs/build/abci/01-prepare-proposal.md b/docs/docs/build/abci/01-prepare-proposal.md index b382435085..aafeda665a 100644 --- a/docs/docs/build/abci/01-prepare-proposal.md +++ b/docs/docs/build/abci/01-prepare-proposal.md @@ -33,7 +33,7 @@ https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-alpha.0/baseapp/abci_utils.go ``` This default implementation can be overridden by the application developer in -favor of a custom implementation in [`app.go`](./01-app-go-v2.md): +favor of a custom implementation in [`app.go`](../building-apps/01-app-go-v2.md): ```go prepareOpt := func(app *baseapp.BaseApp) { diff --git a/docs/docs/build/abci/02-process-proposal.md b/docs/docs/build/abci/02-process-proposal.md index 815c093fe7..53d5d86564 100644 --- a/docs/docs/build/abci/02-process-proposal.md +++ b/docs/docs/build/abci/02-process-proposal.md @@ -18,7 +18,7 @@ https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-alpha.0/baseapp/abci_utils.go# ``` Like `PrepareProposal` this implementation is the default and can be modified by -the application developer in [`app.go`](./01-app-go-v2.md). If you decide to implement +the application developer in [`app.go`](../building-apps/01-app-go-v2.md). If you decide to implement your own `ProcessProposal` handler, you must be sure to ensure that the transactions provided in the proposal DO NOT exceed the maximum block gas and `maxtxbytes` (if set). diff --git a/docs/docs/build/tooling/README.md b/docs/docs/build/tooling/README.md index 27bc94e24f..b0fd78f7dc 100644 --- a/docs/docs/build/tooling/README.md +++ b/docs/docs/build/tooling/README.md @@ -11,7 +11,6 @@ This includes tools for development, operating a node, and ease of use of a Cosm * [Cosmovisor](./01-cosmovisor.md) * [Confix](./02-confix.md) -* [Hubl](./03-hubl.md) * [Rosetta](https://docs.cosmos.network/main/run-node/rosetta) ## Other Tools diff --git a/docs/docs/learn/advanced/05-encoding.md b/docs/docs/learn/advanced/05-encoding.md index 9ddc21d104..76670e3a05 100644 --- a/docs/docs/learn/advanced/05-encoding.md +++ b/docs/docs/learn/advanced/05-encoding.md @@ -91,7 +91,7 @@ https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-alpha.0/x/auth/tx/decoder.go https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-alpha.0/x/auth/tx/encoder.go ``` -See [ADR-020](../../architecture/adr-020-protobuf-transaction-encoding.md) for details of how a transaction is encoded. +See [ADR-020](../../../architecture/adr-020-protobuf-transaction-encoding.md) for details of how a transaction is encoded. ### Interface Encoding and Usage of `Any` @@ -112,7 +112,7 @@ In this `Profile` example, we hardcoded `account` as a `BaseAccount`. However, t https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-alpha.0/types/account.go#L15-L32 ``` -In [ADR-019](../../architecture/adr-019-protobuf-state-encoding.md), it has been decided to use [`Any`](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/any.proto)s to encode interfaces in protobuf. An `Any` contains an arbitrary serialized message as bytes, along with a URL that acts as a globally unique identifier for and resolves to that message's type. This strategy allows us to pack arbitrary Go types inside protobuf messages. Our new `Profile` then looks like: +In [ADR-019](../../../architecture/adr-019-protobuf-state-encoding.md), it has been decided to use [`Any`](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/any.proto)s to encode interfaces in protobuf. An `Any` contains an arbitrary serialized message as bytes, along with a URL that acts as a globally unique identifier for and resolves to that message's type. This strategy allows us to pack arbitrary Go types inside protobuf messages. Our new `Profile` then looks like: ```protobuf message Profile { @@ -181,7 +181,7 @@ func (p *Profile) UnpackInterfaces(unpacker codectypes.AnyUnpacker) error { The `UnpackInterfaces` gets called recursively on all structs implementing this method, to allow all `Any`s to have their `GetCachedValue()` correctly populated. -For more information about interface encoding, and especially on `UnpackInterfaces` and how the `Any`'s `type_url` gets resolved using the `InterfaceRegistry`, please refer to [ADR-019](../../architecture/adr-019-protobuf-state-encoding.md). +For more information about interface encoding, and especially on `UnpackInterfaces` and how the `Any`'s `type_url` gets resolved using the `InterfaceRegistry`, please refer to [ADR-019](../../../architecture/adr-019-protobuf-state-encoding.md). #### `Any` Encoding in the Cosmos SDK @@ -246,7 +246,7 @@ Protobuf types can be defined to encode: #### Naming and conventions We encourage developers to follow industry guidelines: [Protocol Buffers style guide](https://developers.google.com/protocol-buffers/docs/style) -and [Buf](https://buf.build/docs/style-guide), see more details in [ADR 023](../../architecture/adr-023-protobuf-naming.md) +and [Buf](https://buf.build/docs/style-guide), see more details in [ADR 023](../../../architecture/adr-023-protobuf-naming.md) ### How to update modules to protobuf encoding diff --git a/docs/docs/user/user.md b/docs/docs/user/user.md new file mode 100644 index 0000000000..14fc78e92a --- /dev/null +++ b/docs/docs/user/user.md @@ -0,0 +1,10 @@ +--- +sidebar_position: 0 +--- +# User Guides + +This section is designed for developers who are using the Cosmos SDK to build applications. It provides essential guides and references to effectively use the SDK's features. + +* [Setting up keys](./run-node/00-keyring.md) - Learn how to set up secure key management using the Cosmos SDK's keyring feature. This guide provides a streamlined approach to cryptographic key handling, which is crucial for securing your application. +* [Running a node](./run-node/01-run-node.md) - This guide provides step-by-step instructions to deploy and manage a node in the Cosmos network. It ensures a smooth and reliable operation of your blockchain application by covering all the necessary setup and maintenance steps. +* [CLI](./run-node/02-interact-node.md) - Discover how to navigate and interact with the Cosmos SDK using the Command Line Interface (CLI). This section covers efficient and powerful command-based operations that can help you manage your application effectively. \ No newline at end of file diff --git a/docs/pre.sh b/docs/pre.sh index 9ec8b7820c..f004d2f309 100755 --- a/docs/pre.sh +++ b/docs/pre.sh @@ -20,12 +20,11 @@ cp ../x/auth/vesting/README.md ./docs/build/modules/auth/1-vesting.md cp ../x/auth/tx/README.md ./docs/build/modules/auth/2-tx.md ## Add modules page list -cat ../x/README.md | sed 's/\.\.\/docs\/build\/building-modules\/README\.md/\/building-modules\/intro\.html/g' > ./docs/modules/README.md +cat ../x/README.md | sed 's/\.\.\/docs\/build\/building-modules\/README\.md/\/building-modules\/intro\.html/g' > ./docs/build/modules/README.md ## Add tooling documentation cp ../tools/cosmovisor/README.md ./docs/build/tooling/01-cosmovisor.md cp ../tools/confix/README.md ./docs/build/tooling/02-confix.md -cp ../tools/hubl/README.md ./docs/build/tooling/03-hubl.md wget -O docs/user/run-node/04-rosetta.md https://raw.githubusercontent.com/cosmos/rosetta/main/README.md ## Add package documentation diff --git a/x/README.md b/x/README.md index 73ad4aa4c4..5108abc6a0 100644 --- a/x/README.md +++ b/x/README.md @@ -41,7 +41,7 @@ capabilities of your blockchain or further specialize it. ## Deprecated Modules The following modules are deprecated. They will no longer be maintained and eventually will be removed -in an upcoming release of the Cosmos SDK per our [release process](../RELEASE_PROCESS.md). +in an upcoming release of the Cosmos SDK per our [release process](https://github.com/cosmos/cosmos-sdk/blob/main/RELEASE_PROCESS.md). * [Crisis](./crisis/README.md) - *Deprecated* halting the blockchain under certain circumstances (e.g. if an invariant is broken). * [Params](./params/README.md) - *Deprecated* Globally available parameter store.