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 (backport #2269) #2322

Merged
merged 2 commits into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
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