Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: scaffold custom IBC light client development guide #2860

Merged
merged 7 commits into from
Dec 5, 2022
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These will appear on the sidebar right? Would it look cleaner as just "ClientState"?

Suggested change
title: "client_state.go and its functions",
title: "ClientState",

directory: false,
path: "light-clients/client-state.html",
},
{
title: "consensus_state.go and its functions",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here

Suggested change
title: "consensus_state.go and its functions",
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: [
Expand Down
3 changes: 3 additions & 0 deletions docs/ibc/light-clients/client-state.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<!--
order: 2
-->
3 changes: 3 additions & 0 deletions docs/ibc/light-clients/consensus-state.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<!--
order: 3
-->
3 changes: 3 additions & 0 deletions docs/ibc/light-clients/genesis.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<!--
order: 9
-->
3 changes: 3 additions & 0 deletions docs/ibc/light-clients/misbehaviour.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<!--
order: 6
-->
3 changes: 3 additions & 0 deletions docs/ibc/light-clients/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<!--
order: 1
-->
3 changes: 3 additions & 0 deletions docs/ibc/light-clients/proofs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<!--
order: 4
-->
3 changes: 3 additions & 0 deletions docs/ibc/light-clients/proposal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<!--
order: 8
-->
3 changes: 3 additions & 0 deletions docs/ibc/light-clients/update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<!--
order: 5
-->
3 changes: 3 additions & 0 deletions docs/ibc/light-clients/upgrade.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<!--
order: 7
-->