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

docs: add docs on modules #2269

Merged
merged 36 commits into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
9acd9c8
add docs/build folder
mpoke Aug 26, 2024
cf12abc
add module structure
mpoke Sep 5, 2024
3fce170
Merge branch 'main' into marius/docs-modules
mpoke Sep 11, 2024
aad4466
add provider messages to docs -- wip
mpoke Sep 11, 2024
b73bbcf
add message description to docs
mpoke Sep 13, 2024
01321eb
add provider params
mpoke Sep 13, 2024
4d1d03a
add consumer params
mpoke Sep 13, 2024
521a70d
remove params.md
mpoke Sep 13, 2024
f1470b9
fix links
mpoke Sep 13, 2024
1773376
add overview
mpoke Sep 13, 2024
8cc933d
add IBC channel handshake
mpoke Sep 13, 2024
e600759
add OnRecvPacket
mpoke Sep 13, 2024
e8be1a5
move democracy module to build/modules
mpoke Sep 13, 2024
99ce5a4
remove duplicate democracy module page
mpoke Sep 13, 2024
ae9c24a
add begin/end-block info
mpoke Sep 13, 2024
44032e7
Merge branch 'main' into marius/docs-modules
mpoke Sep 18, 2024
1cc95a6
udpate intro section
mpoke Sep 18, 2024
b54ffcf
add info on provider state
mpoke Sep 20, 2024
4c07275
add consumer state
mpoke Sep 21, 2024
e3efea4
add state intro
mpoke Sep 21, 2024
a3525b9
add TODOs
mpoke Sep 21, 2024
b30a4b5
add CLI
sainoe Sep 26, 2024
6609bbd
WIP - add provider CLI, gRPC, REST docs
sainoe Sep 26, 2024
6763c0a
fix typos
sainoe Sep 27, 2024
61ebd23
add consumer docs wip
sainoe Sep 30, 2024
d8ce080
provider docs nits
sainoe Oct 2, 2024
d37e2a2
consumer docs nits
sainoe Oct 2, 2024
7a1e24f
consumer docs improvement
sainoe Oct 2, 2024
a30ddf9
Merge branch 'main' into marius/docs-modules
sainoe Oct 2, 2024
6bc3eb8
merge main
sainoe Oct 2, 2024
205fc2a
fix merge conflicts
mpoke Oct 2, 2024
14ff20c
add collapsible sections
mpoke Oct 2, 2024
007d44a
update overview
mpoke Oct 2, 2024
6a865f2
docs: fix broken docs; cleanup versions (#2321)
MSalopek Oct 2, 2024
8b5f179
expand toc level
mpoke Oct 2, 2024
49f0fe6
fix broken link
mpoke Oct 2, 2024
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
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ release/
docs/tla/states/
*.out
vendor/
build/
/build/
.vscode
.idea
__debug_*
Expand Down
5 changes: 0 additions & 5 deletions docs/build_deploy.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,5 @@ echo "building docusaurus main docs"
cp supported_versions.json versions.json
npm ci && npm run build

# copy "legacy" docs directory into the final build directory
# the directory is in "docs/legacy" of the source branch (legacy-docs-page)
# the build environment must be in "./docs" for this to work as expected
git checkout origin/legacy-docs-page -- legacy
cp -r ./legacy ./build/
mv build ~/output
echo "done building docusaurus main docs"
4 changes: 4 additions & 0 deletions docs/docs/build/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Build",
"position": 3
}
22 changes: 22 additions & 0 deletions docs/docs/build/modules/01-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
sidebar_position: 1
---

# Overview

ICS consists of two main modules:

* [x/provider](./02-provider.md)
* Provides to consumer chains updated information of opted in validators.
* Distributes ICS rewards to opted in validators.
* Jails and slashes validators that misbehave on consumer chains.
* [x/consumer](./03-consumer.md)
* Sends to the consensus engine the validator sets received from the provider chain.
* Splits consumer block rewards and sends ICS rewards to the provider chain.
* Notifies the provider chain of downtime infractions.

Note that `x/types` contains types shared by both modules.

In addition, the following modules are added to ICS to extend its functionality:

* [x/democracy](04-democracy.md)
Loading
Loading