From 25f3132b32149768425789f8db0cf0bad530642b Mon Sep 17 00:00:00 2001 From: Marius Poke Date: Tue, 25 Jun 2024 11:28:28 +0200 Subject: [PATCH] docs: update ADRs rendering (#1937) * update ADRs in docs * chore: ignore templates directories in docs folder * fix broken links * fix broken links --------- Co-authored-by: MSalopek --- CONTRIBUTING.md | 2 +- docs/docs/adrs/adr-004-denom-dos-fixes.md | 2 +- docs/docs/adrs/adr-007-pause-unbonding-on-eqv-prop.md | 2 +- docs/docs/adrs/intro.md | 8 ++++---- docs/docs/adrs/{ => templates}/adr-template.md | 0 docs/docs/features/democracy-modules.md | 4 ++++ docs/docs/features/partial-set-security.md | 2 +- docs/docs/features/power-shaping.md | 4 ++++ docs/docusaurus.config.js | 1 + 9 files changed, 17 insertions(+), 8 deletions(-) rename docs/docs/adrs/{ => templates}/adr-template.md (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6ff634077c..b6aa96afba 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -109,7 +109,7 @@ If your architecture decision is a simple change, you may contribute directly wi In certain circumstances, the architecture decision may require changes to the ICS spec. Note that the spec is responsible for defining language-agnostic, implementation-agnostic behaviors for the ICS protocol. Whereas ADRs are responsible for communicating implementation decisions contained within this repo. -To create an ADR, follow the [template](docs/docs/adrs/adr-template.md) and [doc](docs/docs/adrs/intro.md). If you would like to see examples of how these are written, please refer to the current [ADRs](docs/docs/adrs). +To create an ADR, follow the [template](docs/docs/adrs/templates/adr-template.md) and [doc](docs/docs/adrs/intro.md). If you would like to see examples of how these are written, please refer to the current [ADRs](docs/docs/adrs). ### ADR Proposals diff --git a/docs/docs/adrs/adr-004-denom-dos-fixes.md b/docs/docs/adrs/adr-004-denom-dos-fixes.md index 7ca260f4f6..354eac337f 100644 --- a/docs/docs/adrs/adr-004-denom-dos-fixes.md +++ b/docs/docs/adrs/adr-004-denom-dos-fixes.md @@ -1,6 +1,6 @@ --- sidebar_position: 2 -title: ADR Template +title: Denom DOS fixes --- # ADR 004: Denom DOS fixes diff --git a/docs/docs/adrs/adr-007-pause-unbonding-on-eqv-prop.md b/docs/docs/adrs/adr-007-pause-unbonding-on-eqv-prop.md index ce23051582..2e8e95d67f 100644 --- a/docs/docs/adrs/adr-007-pause-unbonding-on-eqv-prop.md +++ b/docs/docs/adrs/adr-007-pause-unbonding-on-eqv-prop.md @@ -1,6 +1,6 @@ --- sidebar_position: 2 -title: ADR Template +title: Pause validator unbonding during equivocation proposal --- # ADR 007: Pause validator unbonding during equivocation proposal diff --git a/docs/docs/adrs/intro.md b/docs/docs/adrs/intro.md index fc7d06a152..d94a628bf4 100644 --- a/docs/docs/adrs/intro.md +++ b/docs/docs/adrs/intro.md @@ -1,13 +1,13 @@ --- sidebar_position: 1 -title: ADRs +title: Overview --- -# Architecture Decision Records (ADR) +# Overview This is a location to record all high-level architecture decisions in the Interchain Security project. -You can read more about the ADR concept in this [blog post](https://product.reverb.com/documenting-architecture-decisions-the-reverb-way-a3563bb24bd0#.78xhdix6t). +You can read more about the Architecture Decision Record (ADR) concept in this [blog post](https://product.reverb.com/documenting-architecture-decisions-the-reverb-way-a3563bb24bd0#.78xhdix6t). An ADR should provide: @@ -26,7 +26,7 @@ If recorded decisions turned out to be lacking, convene a discussion, record the Note the context/background should be written in the present tense. -To suggest an ADR, please make use of the [ADR template](./adr-template.md) provided. +To suggest an ADR, please make use of the [ADR template](./templates/adr-template.md) provided. ## Table of Contents diff --git a/docs/docs/adrs/adr-template.md b/docs/docs/adrs/templates/adr-template.md similarity index 100% rename from docs/docs/adrs/adr-template.md rename to docs/docs/adrs/templates/adr-template.md diff --git a/docs/docs/features/democracy-modules.md b/docs/docs/features/democracy-modules.md index 5add40c67e..a89466d863 100644 --- a/docs/docs/features/democracy-modules.md +++ b/docs/docs/features/democracy-modules.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 5 +--- + # Democracy modules This section is relevant for chains transitioning from a standalone chain and new consumer chains that require some functionality from the `x/staking` module. diff --git a/docs/docs/features/partial-set-security.md b/docs/docs/features/partial-set-security.md index 6405fe092b..4e221583b5 100644 --- a/docs/docs/features/partial-set-security.md +++ b/docs/docs/features/partial-set-security.md @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 6 --- # Partial Set Security diff --git a/docs/docs/features/power-shaping.md b/docs/docs/features/power-shaping.md index 2f51aef8f0..0b065c3ac0 100644 --- a/docs/docs/features/power-shaping.md +++ b/docs/docs/features/power-shaping.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 7 +--- + # Power Shaping To give consumer chains more flexibility in choosing their validator set, Interchain Security offers diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index e73d5e2a21..17ff9aeb7b 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -56,6 +56,7 @@ const config = { }, remarkPlugins: [remarkMath], rehypePlugins: [rehypeKatex], + exclude: ["**/templates/*"], }, theme: {