Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: collapse module spec and readme #13143

Merged
merged 20 commits into from
Sep 5, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
display vesting in docs
  • Loading branch information
julienrbrt committed Sep 5, 2022
commit a15c04bfb14d7ffc2e199062296c787ec322e768
11 changes: 10 additions & 1 deletion docs/pre.sh
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,21 @@ for D in ../x/*; do
# 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'
rm README.md
mv section_00.md README.md
cd ../..
fi
fi
done

## 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
2 changes: 1 addition & 1 deletion x/auth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ message BaseAccount {

### Vesting Account

See [Vesting](05_vesting.md).
See [Vesting](https://docs.cosmos.network/main/modules/vesting/).

# AnteHandlers

Expand Down
2 changes: 1 addition & 1 deletion x/auth/vesting/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
order: 1
order: 0
title: "Vesting Overview"
parent:
title: "vesting"
Expand Down