diff --git a/.github/workflows/gh-pages.yaml b/.github/workflows/gh-pages.yaml index d7c3adb..b2ab990 100644 --- a/.github/workflows/gh-pages.yaml +++ b/.github/workflows/gh-pages.yaml @@ -28,7 +28,7 @@ jobs: env: MDBOOK_VERSION: 0.4.21 # https://github.com/rust-lang/mdBook/releases - TERA_VERSION: 0.2.2 # https://github.com/chevdor/tera-cli/release + TERA_VERSION: 0.2.4 # https://github.com/chevdor/tera-cli/release steps: - name: Checkout sources diff --git a/README.md b/README.md index 66b0341..1554ed6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # labels -The repo contains specifications related to labels in the `substrate`, `polkadot` and `cumulus` repos. -It uses [ruled_labels](https://github.com/paritytech/ruled_labels) to defined the rules about requirements and interactions between labels. The rules and tests are for all repos the same, only the labels differ for each repo. +The repo contains specifications related to labels for the `polkadot-sdk` repo. -If you need more information, check out the documentation at [https://paritytech.github.io/labels](https://paritytech.github.io/labels). +It uses [ruled_labels](https://github.com/paritytech/ruled_labels) to define the rules, requirements and interactions between labels. +The rules and tests are for all repos the same, only the labels differ for each repo. + +For more information, check out the generated documentation at [https://paritytech.github.io/labels](https://paritytech.github.io/labels). diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 7850cfc..bf186a5 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -3,7 +3,5 @@ [Home](HOME.md) - [Respositories](#) - - [Polkadot](doc_polkadot.md) - - [Cumulus](doc_cumulus.md) - - [Substrate](doc_substrate.md) + - [Polkadot SDK](doc_polkadot-sdk.md) - [FAQ](faq.md) diff --git a/scripts/build-doc.sh b/scripts/build-doc.sh index ce41144..31b926e 100755 --- a/scripts/build-doc.sh +++ b/scripts/build-doc.sh @@ -5,10 +5,10 @@ export COMMIT=$(git rev-parse HEAD) mkdir -p ./docs/src -chains=$1 -chains=${chains:-"substrate polkadot cumulus"} +repo=$1 +repo=${repo:-"polkadot-sdk"} -for chain in $chains; do +for chain in $repo; do echo "Generating doc for $chain..." tera --include --env --env-key env --template templates/template.md.tera ruled_labels/specs_${chain}.yaml >./docs/src/doc_${chain}.md done