chore: scaffold custom IBC light client development guide (cosmos#2860)

iqlusioninc · Dec 19, 2022 · 1742c54 · 1742c54
1 parent 2d33a9f
commit 1742c54
Show file tree

Hide file tree

Showing 10 changed files with 77 additions and 0 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -294,6 +294,56 @@ module.exports = {
             },
           ],
         },
+        {
+          title: "IBC Light Client Developer Guide",
+          children: [
+            {
+              title: "Overview",
+              directory: false,
+              path: "/light-clients/overview.html",
+            },
+            {
+              title: "ClientState",
+              directory: false,
+              path: "light-clients/client-state.html",
+            },
+            {
+              title: "ConsensusState",
+              directory: false,
+              path: "/light-clients/consensus-state.html",
+            },
+            {
+              title: "Existence/Non-Existence Proofs",
+              directory: false,
+              path: "/light-clients/proofs.html",
+            },
+            {
+              title: "Updates Handling",
+              directory: false,
+              path: "/light-clients/update.html",
+            },
+            {
+              title: "Misbehaviour Handling",
+              directory: false,
+              path: "/light-clients/misbehaviour.html",
+            },
+            {
+              title: "Upgrades Handling",
+              directory: false,
+              path: "/light-clients/upgrade.html",
+            },
+            {
+              title: "Proposal Handling",
+              directory: false,
+              path: "/light-clients/proposal.html",
+            },
+            {
+              title: "Genesis Handling",
+              directory: false,
+              path: "/light-clients/genesis.html",
+            },
+          ],
+        },
         {
           title: "IBC Middleware Modules",
           children: [

diff --git a/docs/ibc/light-clients/client-state.md b/docs/ibc/light-clients/client-state.md
@@ -0,0 +1,3 @@
+<!--
+order: 2
+-->
diff --git a/docs/ibc/light-clients/consensus-state.md b/docs/ibc/light-clients/consensus-state.md
@@ -0,0 +1,3 @@
+<!--
+order: 3
+-->
diff --git a/docs/ibc/light-clients/genesis.md b/docs/ibc/light-clients/genesis.md
@@ -0,0 +1,3 @@
+<!--
+order: 9
+-->
diff --git a/docs/ibc/light-clients/misbehaviour.md b/docs/ibc/light-clients/misbehaviour.md
@@ -0,0 +1,3 @@
+<!--
+order: 6
+-->
diff --git a/docs/ibc/light-clients/overview.md b/docs/ibc/light-clients/overview.md
@@ -0,0 +1,3 @@
+<!--
+order: 1
+-->
diff --git a/docs/ibc/light-clients/proofs.md b/docs/ibc/light-clients/proofs.md
@@ -0,0 +1,3 @@
+<!--
+order: 4
+-->
diff --git a/docs/ibc/light-clients/proposal.md b/docs/ibc/light-clients/proposal.md
@@ -0,0 +1,3 @@
+<!--
+order: 8
+-->
diff --git a/docs/ibc/light-clients/update.md b/docs/ibc/light-clients/update.md
@@ -0,0 +1,3 @@
+<!--
+order: 5
+-->
diff --git a/docs/ibc/light-clients/upgrade.md b/docs/ibc/light-clients/upgrade.md
@@ -0,0 +1,3 @@
+<!--
+order: 7
+-->