docs: add docs on modules (#2269)

* add docs/build folder

* add module structure

* add provider messages to docs -- wip

* add message description to docs

* add provider params

* add consumer params

* remove params.md

* fix links

* add overview

* add IBC channel handshake

* add OnRecvPacket

* move democracy module to build/modules

* remove duplicate democracy module page

* add begin/end-block info

* udpate intro section

* add info on provider state

* add consumer state

* add state intro

* add TODOs

* add CLI

* WIP - add provider CLI, gRPC, REST docs

* fix typos

* add consumer docs wip

* provider docs nits

* consumer docs nits

* consumer docs improvement

* merge main

* add collapsible sections

* update overview

* docs: fix broken docs; cleanup versions (#2321)

* docs: update config and supported verisons

* fix broken config

* fix broken version import

* add back missing image

* expand toc level

* fix broken link

---------

Co-authored-by: Simon Noetzlin <[email protected]>
Co-authored-by: MSalopek <[email protected]>

.gitignore

@@ -5,7 +5,7 @@ release/
 docs/tla/states/
 *.out
 vendor/
-build/
+/build/
 .vscode
 .idea
 __debug_*

docs/build_deploy.sh

@@ -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"

docs/docs/build/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Build",
+  "position": 3
+}

docs/docs/build/modules/01-overview.md

@@ -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)