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.

Sign up for GitHub

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

Jump to bottom

chore: scaffold custom IBC light client development guide #2860

Merged
merged 7 commits into from
Dec 5, 2022
Merged

chore: scaffold custom IBC light client development guide #2860

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
73f5a2a
scaff
charleenfei Dec 1, 2022
f3c7400
Merge branch 'main' into charly/1849_light_client_guide
charleenfei Dec 1, 2022
b53b8b7
update vuepress config
charleenfei Dec 1, 2022
acaa47d
Merge branch 'main' into charly/1849_light_client_guide
charleenfei Dec 5, 2022
638c664
update re: pr comments
charleenfei Dec 5, 2022
7d0d901
Merge branch 'charly/1849_light_client_guide' of github.com:cosmos/ib…
charleenfei Dec 5, 2022
fef4dd8
Merge branch 'main' into charly/1849_light_client_guide
charleenfei Dec 5, 2022
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
Prev Previous commit
Next Next commit
update vuepress config
  • Loading branch information
@charleenfei
charleenfei committed Dec 1, 2022
commit b53b8b70edf4e38d164a57ce3a14343709f80181
50 changes: 50 additions & 0 deletions docs/.vuepress/config.js
View file
Open in desktop
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