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 <matija.salopek994@gmail.com>
cosmos · Jun 25, 2024 · 25f3132 · 25f3132
1 parent 2c07a38
commit 25f3132
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 8 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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 → docs/docs/adrs/templates/adr-template.md b/docs/docs/adrs/adr-template.md → docs/docs/adrs/templates/adr-template.md
diff --git 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
@@ -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
@@ -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
@@ -56,6 +56,7 @@ const config = {
           },
           remarkPlugins: [remarkMath],
           rehypePlugins: [rehypeKatex],
+          exclude: ["**/templates/*"],
         },
 
         theme: {