diff --git a/docs/advanced/TODO.stub b/docs/advanced/TODO.stub deleted file mode 100644 index 1f1366e..0000000 --- a/docs/advanced/TODO.stub +++ /dev/null @@ -1,5 +0,0 @@ -# Advanced Sections to Add - -- [ ] Rename Encryption SDK and Repos named it -- [ ] `fairy` module encompassing the idea of a "module" that allows the integration of chains and EVM apps. Instead of referring to the specific x/pep, or precompiles. -- [ ] \ No newline at end of file diff --git a/docs/advanced/_category_.json b/docs/advanced/_category_.json index 24908f7..c57c288 100644 --- a/docs/advanced/_category_.json +++ b/docs/advanced/_category_.json @@ -2,6 +2,9 @@ "label": "Advanced", "position": 4, "link": { - "type": "generated-index" - } + "type": "doc", + "id": "advanced" + }, + "collapsible": true, + "collapsed": true } diff --git a/docs/advanced/advanced.md b/docs/advanced/advanced.md new file mode 100644 index 0000000..8926c26 --- /dev/null +++ b/docs/advanced/advanced.md @@ -0,0 +1,33 @@ +--- +sidebar_position: 1 +--- + +# Developer Advanced Section + +This section delves deeper into various components of the Fairblock ecosystem. + +In case you're looking for certain topics, the docs have covered: + +1. The vision of Fairblock within the [welcome section](../welcome/welcome_to_fairblock.md) +2. The basics of Fairblock within the [learn section](../learn/overview.md) +3. A showcase of different [example builds and where to find them](../example-builds/start_building.md) +4. How to run a node within the [Fairyring network](../category/running-a-node) + +> **The docs are actively being updated. If there are components that you would like more information on, please reach out to us on [Discord](https://discord.gg/K38ya6ymT6) as always!** + +The topics covered within the advanced section presently include: + +**Details on Fairyring** + +1. [An example showcasing the use of `fairyring` to request a new id, encrypt, and decrypt a transaction](./conditional_encryption_decryption.md) +2. [What `fairyport` is and how to set it up and run it](./fairyport.md) +3. [What `x/keyshare` is](./keyshare_module.md) +4. [Using `share-generation` (built into `fairyring`) to generate & derive keyshares for local development](./share_generator.md) + +**Details for Cosmos Chains Integrations** +1. [What `x/pep` is](./cosmos-chains-integration-details/pep_module.md) +2. [How to use the `x/pep` module using `encrypter` built into `fairyring`](./cosmos-chains-integration-details/encrypt_tx.md) + +**Details for EVM Integrations** + +This section is under progress and will be updated shortly. diff --git a/docs/advanced/cosmos-chains-integration-details/_category_.json b/docs/advanced/cosmos-chains-integration-details/_category_.json new file mode 100644 index 0000000..3f17854 --- /dev/null +++ b/docs/advanced/cosmos-chains-integration-details/_category_.json @@ -0,0 +1,6 @@ +{ + "label": "Cosmos Integrations Details", + "position": 3, + "collapsible": true, + "collapsed": true +} diff --git a/docs/advanced/encrypt_tx.md b/docs/advanced/cosmos-chains-integration-details/encrypt_tx.md similarity index 100% rename from docs/advanced/encrypt_tx.md rename to docs/advanced/cosmos-chains-integration-details/encrypt_tx.md diff --git a/docs/advanced/pep_module.md b/docs/advanced/cosmos-chains-integration-details/pep_module.md similarity index 100% rename from docs/advanced/pep_module.md rename to docs/advanced/cosmos-chains-integration-details/pep_module.md diff --git a/docs/advanced/evm-chains-integration-details/_category_.json b/docs/advanced/evm-chains-integration-details/_category_.json new file mode 100644 index 0000000..7810dad --- /dev/null +++ b/docs/advanced/evm-chains-integration-details/_category_.json @@ -0,0 +1,6 @@ +{ + "label": "EVMs Integrations Details", + "position": 4, + "collapsible": true, + "collapsed": true +} diff --git a/docs/advanced/evm-chains-integration-details/evm.md b/docs/advanced/evm-chains-integration-details/evm.md new file mode 100644 index 0000000..4e45415 --- /dev/null +++ b/docs/advanced/evm-chains-integration-details/evm.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 1 +--- + +# Details for EVM Integrations + +This section is under progress and will be updated shortly. \ No newline at end of file diff --git a/docs/advanced/fairyring-details/_category_.json b/docs/advanced/fairyring-details/_category_.json new file mode 100644 index 0000000..655dc2a --- /dev/null +++ b/docs/advanced/fairyring-details/_category_.json @@ -0,0 +1,6 @@ +{ + "label": "Fairyring Details", + "position": 2, + "collapsible": true, + "collapsed": true +} diff --git a/docs/advanced/conditional_encryption_decryption.md b/docs/advanced/fairyring-details/conditional_encryption_decryption.md similarity index 98% rename from docs/advanced/conditional_encryption_decryption.md rename to docs/advanced/fairyring-details/conditional_encryption_decryption.md index f4a0150..c154fd3 100644 --- a/docs/advanced/conditional_encryption_decryption.md +++ b/docs/advanced/fairyring-details/conditional_encryption_decryption.md @@ -1,8 +1,8 @@ --- -sidebar_position: 5 +sidebar_position: 1 --- -# Conditional Encryption/Decryption +# Conditional Encryption In the [overview](/docs/basics/overview.md), we saw a general flow for how to interact with `fairyring`. In particular, the chain provides functionality on requesting specific encryption keys corresponding to conditions set by the developer. diff --git a/docs/advanced/fairyport.md b/docs/advanced/fairyring-details/fairyport.md similarity index 99% rename from docs/advanced/fairyport.md rename to docs/advanced/fairyring-details/fairyport.md index b4d6fcf..f99863d 100644 --- a/docs/advanced/fairyport.md +++ b/docs/advanced/fairyring-details/fairyport.md @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 2 --- # `fairyport` diff --git a/docs/advanced/keyshare_module.md b/docs/advanced/fairyring-details/keyshare_module.md similarity index 99% rename from docs/advanced/keyshare_module.md rename to docs/advanced/fairyring-details/keyshare_module.md index e3c928b..2c2c461 100644 --- a/docs/advanced/keyshare_module.md +++ b/docs/advanced/fairyring-details/keyshare_module.md @@ -1,5 +1,5 @@ --- -sidebar_position: 0 +sidebar_position: 3 --- # `x/keyshare` diff --git a/docs/advanced/share_generator.md b/docs/advanced/fairyring-details/share_generator.md similarity index 99% rename from docs/advanced/share_generator.md rename to docs/advanced/fairyring-details/share_generator.md index e4fe137..9307000 100644 --- a/docs/advanced/share_generator.md +++ b/docs/advanced/fairyring-details/share_generator.md @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 4 --- # `ShareGeneration`