diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index aead1124617..9c44dcecbb8 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -322,52 +322,86 @@ module.exports = { ], }, { - title: "IBC Light Client Developer Guide", + title: "IBC Light Clients", 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: "Developer Guide", + directory: true, + path: "/ibc/light-clients", + children: [ + { + title: "Overview", + directory: false, + path: "/ibc/light-clients/overview.html", + }, + { + title: "ClientState", + directory: false, + path: "/ibc/light-clients/client-state.html", + }, + { + title: "ConsensusState", + directory: false, + path: "/ibc/light-clients/consensus-state.html", + }, + { + title: "Existence/Non-Existence Proofs", + directory: false, + path: "/ibc/light-clients/proofs.html", + }, + { + title: "Updates Handling", + directory: false, + path: "/ibc/light-clients/update.html", + }, + { + title: "Misbehaviour Handling", + directory: false, + path: "/ibc/light-clients/misbehaviour.html", + }, + { + title: "Upgrades Handling", + directory: false, + path: "/ibc/light-clients/upgrade.html", + }, + { + title: "Proposal Handling", + directory: false, + path: "/ibc/light-clients/proposal.html", + }, + { + title: "Genesis Handling", + directory: false, + path: "/ibc/light-clients/genesis.html", + }, + ] }, { - title: "Genesis Handling", - directory: false, - path: "/light-clients/genesis.html", + title: "Solomachine", + directory: true, + path: "/ibc/light-clients/solomachine", + children: [ + { + title: "Solomachine", + directory: false, + path: "/ibc/light-clients/solomachine/solomachine.html", + }, + { + title: "Concepts", + directory: false, + path: "/ibc/light-clients/solomachine/concepts.html", + }, + { + title: "State", + directory: false, + path: "/ibc/light-clients/solomachine/state.html", + }, + { + title: "State Transitions", + directory: false, + path: "/ibc/light-clients/solomachine/state_transitions.html", + }, + ], }, ], }, diff --git a/modules/light-clients/06-solomachine/spec/01_concepts.md b/docs/ibc/light-clients/solomachine/concepts.md similarity index 95% rename from modules/light-clients/06-solomachine/spec/01_concepts.md rename to docs/ibc/light-clients/solomachine/concepts.md index c5df3f7e1b4..ac74e6e807d 100644 --- a/modules/light-clients/06-solomachine/spec/01_concepts.md +++ b/docs/ibc/light-clients/solomachine/concepts.md @@ -56,7 +56,7 @@ data := &ClientStateData{ dataBz, err := cdc.Marshal(data) ``` -The helper functions `...DataBytes()` in [proof.go](../proof.go) handle this +The helper functions `...DataBytes()` in [proof.go](../../../../modules/light-clients/06-solomachine/proof.go) handle this functionality. 2. Construct the `SignBytes` and marshal it. @@ -75,7 +75,7 @@ signBytes := &SignBytes{ signBz, err := cdc.Marshal(signBytes) ``` -The helper functions `...SignBytes()` in [proof.go](../proof.go) handle this functionality. +The helper functions `...SignBytes()` in [proof.go](../../../../modules/light-clients/06-solomachine/proof.go) handle this functionality. The `DataType` field is used to disambiguate what type of data was signed to prevent potential proto encoding overlap. diff --git a/modules/light-clients/06-solomachine/spec/README.md b/docs/ibc/light-clients/solomachine/solomachine.md similarity index 100% rename from modules/light-clients/06-solomachine/spec/README.md rename to docs/ibc/light-clients/solomachine/solomachine.md diff --git a/modules/light-clients/06-solomachine/spec/02_state.md b/docs/ibc/light-clients/solomachine/state.md similarity index 99% rename from modules/light-clients/06-solomachine/spec/02_state.md rename to docs/ibc/light-clients/solomachine/state.md index 51cb1f058c6..a4b9f87cf8c 100644 --- a/modules/light-clients/06-solomachine/spec/02_state.md +++ b/docs/ibc/light-clients/solomachine/state.md @@ -6,4 +6,3 @@ order: 2 The solo machine light client will only store consensus states for each update by a header or a governance proposal. The latest client state is also maintained in the store. - diff --git a/modules/light-clients/06-solomachine/spec/03_state_transitions.md b/docs/ibc/light-clients/solomachine/state_transitions.md similarity index 100% rename from modules/light-clients/06-solomachine/spec/03_state_transitions.md rename to docs/ibc/light-clients/solomachine/state_transitions.md