From 27c0a90522f3fffa2149506e440bd442942b3ebc Mon Sep 17 00:00:00 2001 From: Zach Date: Fri, 10 Dec 2021 11:10:11 -0500 Subject: [PATCH] docs: add READMEs to each modules' directory (#10721) ## Description Closes: #10588 --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [x] provided a link to the relevant issue or specification - [x] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [x] updated the relevant documentation or specification - [x] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable) --- x/README.md | 3 ++- x/auth/README.md | 7 +++++++ x/authz/README.md | 7 +++++++ x/bank/README.md | 7 +++++++ x/capability/README.md | 7 +++++++ x/crisis/README.md | 7 +++++++ x/distribution/README.md | 7 +++++++ x/epoching/README.md | 7 +++++++ x/evidence/README.md | 7 +++++++ x/feegrant/README.md | 7 +++++++ x/gov/README.md | 7 +++++++ x/mint/README.md | 7 +++++++ x/params/README.md | 7 +++++++ x/slashing/README.md | 7 +++++++ x/staking/README.md | 7 +++++++ x/upgrade/README.md | 7 +++++++ 16 files changed, 107 insertions(+), 1 deletion(-) create mode 100644 x/auth/README.md create mode 100644 x/authz/README.md create mode 100644 x/bank/README.md create mode 100644 x/capability/README.md create mode 100644 x/crisis/README.md create mode 100644 x/distribution/README.md create mode 100644 x/epoching/README.md create mode 100644 x/evidence/README.md create mode 100644 x/feegrant/README.md create mode 100644 x/gov/README.md create mode 100644 x/mint/README.md create mode 100644 x/params/README.md create mode 100644 x/slashing/README.md create mode 100644 x/staking/README.md create mode 100644 x/upgrade/README.md diff --git a/x/README.md b/x/README.md index 86ff7e4823..2b7b78ed04 100644 --- a/x/README.md +++ b/x/README.md @@ -6,12 +6,13 @@ order: 0 Here are some production-grade modules that can be used in Cosmos SDK applications, along with their respective documentation: -- [Auth](auth/spec/README.md) - Authentication of accounts and transactions for Cosmos SDK application. +- [Auth](auth/spec/README.md) - Authentication of accounts and transactions for Cosmos SDK applications. - [Authz](authz/spec/README.md) - Authorization for accounts to perform actions on behalf of other accounts. - [Bank](bank/spec/README.md) - Token transfer functionalities. - [Capability](capability/spec/README.md) - Object capability implementation. - [Crisis](crisis/spec/README.md) - Halting the blockchain under certain circumstances (e.g. if an invariant is broken). - [Distribution](distribution/spec/README.md) - Fee distribution, and staking token provision distribution. +- [Epoching](epoching/spec/README.md) - Allows modules to queue messages for execution at a certain block height. - [Evidence](evidence/spec/README.md) - Evidence handling for double signing, misbehaviour, etc. - [Feegrant](feegrant/spec/README.md) - Grant fee allowances for executing transactions. - [Governance](gov/spec/README.md) - On-chain proposals and voting. diff --git a/x/auth/README.md b/x/auth/README.md new file mode 100644 index 0000000000..67aaaf7e71 --- /dev/null +++ b/x/auth/README.md @@ -0,0 +1,7 @@ + + +# Auth + +- [Auth](spec/README.md) - Authentication of accounts and transactions for Cosmos SDK applications. diff --git a/x/authz/README.md b/x/authz/README.md new file mode 100644 index 0000000000..904cc3755c --- /dev/null +++ b/x/authz/README.md @@ -0,0 +1,7 @@ + + +# Authz + +- [Authz](spec/README.md) - Authorization for accounts to perform actions on behalf of other accounts. diff --git a/x/bank/README.md b/x/bank/README.md new file mode 100644 index 0000000000..2964523ae4 --- /dev/null +++ b/x/bank/README.md @@ -0,0 +1,7 @@ + + +# Bank + +- [Bank](spec/README.md) - Token transfer functionalities. diff --git a/x/capability/README.md b/x/capability/README.md new file mode 100644 index 0000000000..d7a0ae2e89 --- /dev/null +++ b/x/capability/README.md @@ -0,0 +1,7 @@ + + +# Capability + +- [Capability](spec/README.md) - Object capability implementation. diff --git a/x/crisis/README.md b/x/crisis/README.md new file mode 100644 index 0000000000..2d811fa103 --- /dev/null +++ b/x/crisis/README.md @@ -0,0 +1,7 @@ + + +# Crisis + +- [Crisis](spec/README.md) - Halting the blockchain under certain circumstances (e.g. if an invariant is broken). diff --git a/x/distribution/README.md b/x/distribution/README.md new file mode 100644 index 0000000000..b3f136913a --- /dev/null +++ b/x/distribution/README.md @@ -0,0 +1,7 @@ + + +# Distribution + +- [Distribution](spec/README.md) - Fee distribution, and staking token provision distribution. diff --git a/x/epoching/README.md b/x/epoching/README.md new file mode 100644 index 0000000000..7796fc1a4c --- /dev/null +++ b/x/epoching/README.md @@ -0,0 +1,7 @@ + + +# Epoching + +- [Epoching](epoching/spec/README.md) - Allows modules to queue messages for execution at a certain block height. diff --git a/x/evidence/README.md b/x/evidence/README.md new file mode 100644 index 0000000000..8db5c18453 --- /dev/null +++ b/x/evidence/README.md @@ -0,0 +1,7 @@ + + +# Evidence + +- [Evidence](spec/README.md) - Evidence handling for double signing, misbehaviour, etc. diff --git a/x/feegrant/README.md b/x/feegrant/README.md new file mode 100644 index 0000000000..46894bfa6b --- /dev/null +++ b/x/feegrant/README.md @@ -0,0 +1,7 @@ + + +# Feegrant + +- [Feegrant](spec/README.md) - Grant fee allowances for executing transactions. diff --git a/x/gov/README.md b/x/gov/README.md new file mode 100644 index 0000000000..540b435d28 --- /dev/null +++ b/x/gov/README.md @@ -0,0 +1,7 @@ + + +# Governance + +- [Governance](spec/README.md) - On-chain proposals and voting. diff --git a/x/mint/README.md b/x/mint/README.md new file mode 100644 index 0000000000..fbdb897be2 --- /dev/null +++ b/x/mint/README.md @@ -0,0 +1,7 @@ + + +# Mint + +- [Mint](spec/README.md) - Creation of new units of staking token. diff --git a/x/params/README.md b/x/params/README.md new file mode 100644 index 0000000000..e3066a0cad --- /dev/null +++ b/x/params/README.md @@ -0,0 +1,7 @@ + + +# Params + +- [Params](spec/README.md) - Globally available parameter store. diff --git a/x/slashing/README.md b/x/slashing/README.md new file mode 100644 index 0000000000..fe0e93bcf3 --- /dev/null +++ b/x/slashing/README.md @@ -0,0 +1,7 @@ + + +# Slashing + +- [Slashing](spec/readme.md) - validator punishment mechanisms. diff --git a/x/staking/README.md b/x/staking/README.md new file mode 100644 index 0000000000..725105a1ed --- /dev/null +++ b/x/staking/README.md @@ -0,0 +1,7 @@ + + +# Staking + +- [Staking](spec/README.md) - Proof-of-Stake layer for public blockchains. diff --git a/x/upgrade/README.md b/x/upgrade/README.md new file mode 100644 index 0000000000..198df73404 --- /dev/null +++ b/x/upgrade/README.md @@ -0,0 +1,7 @@ + + +# Upgrade + +- [Upgrade](spec/README.md) - Software upgrades handling and coordination.