From 73f5a2a26847185e5386a098329d2028f6d9f721 Mon Sep 17 00:00:00 2001 From: Charly Date: Thu, 1 Dec 2022 11:39:09 +0100 Subject: [PATCH 1/3] scaff --- docs/ibc/light-clients/client-state.md | 3 +++ docs/ibc/light-clients/consensus-state.md | 3 +++ docs/ibc/light-clients/genesis.md | 3 +++ docs/ibc/light-clients/misbehaviour.md | 3 +++ docs/ibc/light-clients/overview.md | 3 +++ docs/ibc/light-clients/proofs.md | 3 +++ docs/ibc/light-clients/proposal.md | 3 +++ docs/ibc/light-clients/update.md | 3 +++ docs/ibc/light-clients/upgrade.md | 3 +++ 9 files changed, 27 insertions(+) create mode 100644 docs/ibc/light-clients/client-state.md create mode 100644 docs/ibc/light-clients/consensus-state.md create mode 100644 docs/ibc/light-clients/genesis.md create mode 100644 docs/ibc/light-clients/misbehaviour.md create mode 100644 docs/ibc/light-clients/overview.md create mode 100644 docs/ibc/light-clients/proofs.md create mode 100644 docs/ibc/light-clients/proposal.md create mode 100644 docs/ibc/light-clients/update.md create mode 100644 docs/ibc/light-clients/upgrade.md diff --git a/docs/ibc/light-clients/client-state.md b/docs/ibc/light-clients/client-state.md new file mode 100644 index 00000000000..cfb3805268f --- /dev/null +++ b/docs/ibc/light-clients/client-state.md @@ -0,0 +1,3 @@ + \ No newline at end of file diff --git a/docs/ibc/light-clients/consensus-state.md b/docs/ibc/light-clients/consensus-state.md new file mode 100644 index 00000000000..04de84a83d6 --- /dev/null +++ b/docs/ibc/light-clients/consensus-state.md @@ -0,0 +1,3 @@ + \ No newline at end of file diff --git a/docs/ibc/light-clients/genesis.md b/docs/ibc/light-clients/genesis.md new file mode 100644 index 00000000000..695231196ad --- /dev/null +++ b/docs/ibc/light-clients/genesis.md @@ -0,0 +1,3 @@ + \ No newline at end of file diff --git a/docs/ibc/light-clients/misbehaviour.md b/docs/ibc/light-clients/misbehaviour.md new file mode 100644 index 00000000000..99529dc2775 --- /dev/null +++ b/docs/ibc/light-clients/misbehaviour.md @@ -0,0 +1,3 @@ + \ No newline at end of file diff --git a/docs/ibc/light-clients/overview.md b/docs/ibc/light-clients/overview.md new file mode 100644 index 00000000000..4e10266dfdb --- /dev/null +++ b/docs/ibc/light-clients/overview.md @@ -0,0 +1,3 @@ + \ No newline at end of file diff --git a/docs/ibc/light-clients/proofs.md b/docs/ibc/light-clients/proofs.md new file mode 100644 index 00000000000..197c44cbc2b --- /dev/null +++ b/docs/ibc/light-clients/proofs.md @@ -0,0 +1,3 @@ + \ No newline at end of file diff --git a/docs/ibc/light-clients/proposal.md b/docs/ibc/light-clients/proposal.md new file mode 100644 index 00000000000..1aa80c4f77e --- /dev/null +++ b/docs/ibc/light-clients/proposal.md @@ -0,0 +1,3 @@ + \ No newline at end of file diff --git a/docs/ibc/light-clients/update.md b/docs/ibc/light-clients/update.md new file mode 100644 index 00000000000..ff7a3c6ce6b --- /dev/null +++ b/docs/ibc/light-clients/update.md @@ -0,0 +1,3 @@ + \ No newline at end of file diff --git a/docs/ibc/light-clients/upgrade.md b/docs/ibc/light-clients/upgrade.md new file mode 100644 index 00000000000..cf8eae46ed7 --- /dev/null +++ b/docs/ibc/light-clients/upgrade.md @@ -0,0 +1,3 @@ + \ No newline at end of file From b53b8b70edf4e38d164a57ce3a14343709f80181 Mon Sep 17 00:00:00 2001 From: Charly Date: Thu, 1 Dec 2022 18:52:05 +0100 Subject: [PATCH 2/3] update vuepress config --- docs/.vuepress/config.js | 50 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index a5b2f54d145..893a4482f4e 100644 --- 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: "client_state.go and its functions", + directory: false, + path: "light-clients/client-state.html", + }, + { + title: "consensus_state.go and its functions", + 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: [ From 638c66454a2dce5c23e60e78b9c510d4870a5f52 Mon Sep 17 00:00:00 2001 From: Charly Date: Mon, 5 Dec 2022 14:51:40 +0100 Subject: [PATCH 3/3] update re: pr comments --- docs/.vuepress/config.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 893a4482f4e..69c8480f7d4 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -303,12 +303,12 @@ module.exports = { path: "/light-clients/overview.html", }, { - title: "client_state.go and its functions", + title: "ClientState", directory: false, path: "light-clients/client-state.html", }, { - title: "consensus_state.go and its functions", + title: "ConsensusState", directory: false, path: "/light-clients/consensus-state.html", },