chore: collapse module spec and readme

docs/pre.sh

@@ -4,11 +4,30 @@ mkdir -p modules
 
 for D in ../x/*; do
   if [ -d "${D}" ]; then
-    rm -rf "modules/$(echo $D | awk -F/ '{print $NF}')"
-    mkdir -p "modules/$(echo $D | awk -F/ '{print $NF}')" && cp -r $D/spec/* "$_"
+    MODDOC=modules/$(echo $D | awk -F/ '{print $NF}')
+    rm -rf $MODDOC
+    mkdir -p $MODDOC && cp -r $D/README.md "$_"
+    if [ -f "$MODDOC/README.md" ]; then
+      cd $MODDOC
+      # This ensures that we have multiples pages for the modules documantation
+      # This is easier to read for the user
+      # In order to split pages, we need to add a <!-- order: X --> in the module README.md, for each pages that we want.
+      csplit -k -q README.md '/<!-- order:/' '{*}' --prefix='section_' --suffix-format='%02d.md'
+      mv section_00.md README.md
+      cd ../..
+    fi
   fi
 done
 
-cat ../x/README.md | sed 's/\.\/x/\/modules/g' | sed 's/spec\/README.md//g' | sed 's/\.\.\/docs\/building-modules\/README\.md/\/building-modules\/intro\.html/g' > ./modules/README.md
+## Vesting is a submodule of auth, but we still want to display it in docs
+## TODO to be removed in https://github.com/cosmos/cosmos-sdk/issues/9958
+mkdir -p modules/vesting
+cp -r ../x/auth/vesting/README.md modules/vesting
+cd modules/vesting
+csplit -k -q README.md '/<!-- order:/' '{*}' --prefix='section_' --suffix-format='%02d.md'
+mv section_00.md README.md
+cd ../..
+
+cat ../x/README.md | sed 's/\.\/x/\/modules/g' | sed 's/\.\.\/docs\/building-modules\/README\.md/\/building-modules\/intro\.html/g' > ./modules/README.md
 
 cp ../cosmovisor/README.md ./run-node/cosmovisor.md

x/README.md

@@ -6,22 +6,22 @@ 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 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.
-* [Mint](mint/spec/README.md) - Creation of new units of staking token.
-* [Params](params/spec/README.md) - Globally available parameter store.
-* [Slashing](slashing/spec/README.md) - Validator punishment mechanisms.
-* [Staking](staking/spec/README.md) - Proof-of-Stake layer for public blockchains.
-* [Upgrade](upgrade/spec/README.md) - Software upgrades handling and coordination.
-* [Nft](nft/spec/README.md) - NFT module implemented based on [ADR43](https://docs.cosmos.network/master/architecture/adr-043-nft-module.html).
+* [Auth](auth/README.md) - Authentication of accounts and transactions for Cosmos SDK applications.
+* [Authz](authz/README.md) - Authorization for accounts to perform actions on behalf of other accounts.
+* [Bank](bank/README.md) - Token transfer functionalities.
+* [Capability](capability/README.md) - Object capability implementation.
+* [Crisis](crisis/README.md) - Halting the blockchain under certain circumstances (e.g. if an invariant is broken).
+* [Distribution](distribution/README.md) - Fee distribution, and staking token provision distribution.
+* [Epoching](epoching/README.md) - Allows modules to queue messages for execution at a certain block height.
+* [Evidence](evidence/README.md) - Evidence handling for double signing, misbehaviour, etc.
+* [Feegrant](feegrant/README.md) - Grant fee allowances for executing transactions.
+* [Governance](gov/README.md) - On-chain proposals and voting.
+* [Mint](mint/README.md) - Creation of new units of staking token.
+* [Params](params/README.md) - Globally available parameter store.
+* [Slashing](slashing/README.md) - Validator punishment mechanisms.
+* [Staking](staking/README.md) - Proof-of-Stake layer for public blockchains.
+* [Upgrade](upgrade/README.md) - Software upgrades handling and coordination.
+* [NFT](nft/README.md) - NFT module implemented based on [ADR43](https://docs.cosmos.network/main/architecture/adr-043-nft-module.html).
 
 To learn more about the process of building modules, visit the [building modules reference documentation](../docs/building-modules/README.md).