-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* update index in builders * change index to new style cards * update cards index pages, WIP * update index * update index * update all index to the new cards layout * remove images from index-page builders * Hides XCM related articles * Hides XCM from the learn section * add hide: toc to all builders index page * Update indexs according to feedback * wip index * wip * update indexs * fix mermaid bug * Runtime features * reformat index pages * update index pages * restore index pages from other sections to avoid conflicts * update a couple more * add icons to appchain build and appchain template index * add icons to customize your appchain index and docs * add icons to deploy your appchain index and docs * add icons to manage your appchain index and docs * add icons to ethereum tools and docs * add icons to sustrate tools and docs * add icons to integrations and docs * add icons to account mgt and docs * add icons to Tanssi neworks index and docs * update icons according to feedback WIP * update icons according to feedback WIP * finish update icons according to feedback * change appchains for networks in index WIP * finish change words appchain to networks * Apply suggestions from code review Appy changes according to feedback Co-authored-by: Erin Shaben <[email protected]> * Update builders/manage/dapp/index.md quick fix Co-authored-by: Erin Shaben <[email protected]> * Update builders/manage/index.md fix typo Co-authored-by: Erin Shaben <[email protected]> * Lukem/index page learn (#212) * workflow fix * resolve workflow issue * Hides XCM related articles * Hides XCM from the learn section * learn general index update * update index appchain test * update appchain index * update index tanssi * update network features index * add icons to tanssi index * add icons to framework index * fix overview icons and add icons to appchains index * fix typo index learn * rearrange Learn Index and add missing icons to index pages * Apply suggestions from code review apply feedback Co-authored-by: Erin Shaben <[email protected]> * Add changes according to feedback * Update learn/index.md Add changes According to feedback Co-authored-by: Erin Shaben <[email protected]> * changes according to the latest feedback * Apply suggestions from code review apply changes according to feedback Co-authored-by: Erin Shaben <[email protected]> * change words appchains for networks in index * Apply suggestions from code review apply changes according to the feedback Co-authored-by: Erin Shaben <[email protected]> * Lukem/index page node (#214) * update node operators index WIP * update all index on Node * Change descriptions from appchain nodes to network nodes and from block producers to sequencers. * Change the name folders to the new names * Apply suggestions from code review Update according to feedback Co-authored-by: Erin Shaben <[email protected]> * update all icons according to feedback * Apply suggestions from code review Add changes according to feedback Co-authored-by: Erin Shaben <[email protected]> * update according feedback WIP * update run a sequencer index with hardware recommendations * remove hardware recommendations int he docs * fix typo * Add node description to main index * change folders name appchain-node to network-node and fix links * change folders name block-producers to sequencers and fix links * fix typo * Update node-operators/sequencers/onboarding/index.md fix link Co-authored-by: Erin Shaben <[email protected]> * Update node-operators/sequencers/onboarding/index.md fix typo Co-authored-by: Erin Shaben <[email protected]> * Update node-operators/sequencers/onboarding/run-a-sequencer/index.md minor change Co-authored-by: Erin Shaben <[email protected]> * Update node-operators/sequencers/onboarding/run-a-sequencer/index.md minor fix Co-authored-by: Erin Shaben <[email protected]> * Update node-operators/sequencers/operational-tasks/upgrade-your-node/index.md minor fix Co-authored-by: Erin Shaben <[email protected]> * Update node-operators/sequencers/operational-tasks/upgrade-your-node/index.md wording Co-authored-by: Erin Shaben <[email protected]> --------- Co-authored-by: Erin Shaben <[email protected]> --------- Co-authored-by: Ilaria Enache <[email protected]> Co-authored-by: albertov19 <[email protected]> Co-authored-by: augustocollado <[email protected]> Co-authored-by: augustocollado <[email protected]> Co-authored-by: Erin Shaben <[email protected]> --------- Co-authored-by: augustocollado <[email protected]> Co-authored-by: augustocollado <[email protected]> Co-authored-by: Erin Shaben <[email protected]> Co-authored-by: Ilaria Enache <[email protected]> Co-authored-by: albertov19 <[email protected]>
- Loading branch information
1 parent
0da86ca
commit 2f41f6a
Showing
345 changed files
with
1,090 additions
and
373 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,16 @@ | ||
--- | ||
title: Account Management | ||
description: Learn how to manage all account related activities such as the creation, maintenance, and removal of proxies and identities. | ||
template: subsection-index-page.html | ||
hide: | ||
- toc | ||
- feedback | ||
icon: octicons-person-add-24 | ||
template: index-page.html | ||
--- | ||
|
||
# Account Management | ||
|
||
On-chain account management gives users and developers greater flexibility and control over how their accounts interact with a decentralized network. You can fine-tune your account configurations for seamless integration within the ecosystem by managing roles, permissions, and identities directly on-chain. | ||
|
||
This section outlines some of the tools and features related to account management. | ||
|
||
## Explore What This Section Covers | ||
|
||
:::INSERT_GENERATED_CARDS::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
title: Build Your Appchain | ||
title: Build Your Network | ||
hide: false | ||
nav: | ||
- index.md | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
title: Customize Your Appchain | ||
title: Customize Your Network | ||
hide: false | ||
nav: | ||
- index.md | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,37 @@ | ||
--- | ||
title: Customize Your Appchain | ||
description: Set up your local environment and start using the templates to build your appchain with Substrate, a powerful and modular blockchain framework based in Rust. | ||
template: subsection-index-page.html | ||
hide: | ||
- toc | ||
- feedback | ||
title: Customize Your Tanssi-Powered Network | ||
description: Set up your local environment and start using the templates to build your network with Substrate, a powerful and modular blockchain framework based in Rust. | ||
icon: octicons-code-24 | ||
template: index-page.html | ||
--- | ||
|
||
# Customize Your Tanssi-Powered Network | ||
|
||
Tailor your network to meet your application's unique requirements. This section provides guidance on modifying and extending your network's functionality, offering instructions and best practices to help align it with your project's goals. | ||
|
||
## Process for Customizing Your Network | ||
|
||
The diagram below provides a simplified outline of the essential steps to get started with building and customizing your Tanssi-powered network. | ||
|
||
```mermaid | ||
flowchart LR | ||
A[Install software prerequisites] --> B[Create and add modules] | ||
B --> C[Customize and generate chain specs] | ||
style A fill:#151719,stroke:#4ecdc4,stroke-width:2px,rx:10px,ry:10px | ||
style B fill:#151719,stroke:#4ecdc4,stroke-width:2px,rx:10px,ry:10px | ||
style C fill:#151719,stroke:#4ecdc4,stroke-width:2px,rx:10px,ry:10px | ||
%% arrow style | ||
linkStyle default stroke-width:2px,stroke:#ccc | ||
%% add padding | ||
class A,B,C node-padding; | ||
classDef node-padding padding:10px; | ||
``` | ||
|
||
To proceed, check out the following section where you can find detailed, step-by-step guides for each of these stages. | ||
|
||
## Explore What This Section Covers | ||
|
||
:::INSERT_GENERATED_CARDS::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,46 @@ | ||
--- | ||
title: Build Your Appchain | ||
description: Install the software to compile your Tanssi appchain, configure your genesis state and core functionalities, test locally, and prepare to deploy through Tanssi. | ||
template: subsection-index-page.html | ||
hide: | ||
- toc | ||
- feedback | ||
title: Build Your Network | ||
description: Install the software to compile your Tanssi-powered network, configure genesis state and core functions, test locally, and prepare for deployment. | ||
icon: material-widgets-outline | ||
template: index-page.html | ||
--- | ||
|
||
# Build Your Network | ||
|
||
Launching your Tanssi-powered network gives you the flexibility to choose between pre-configured templates or fully customized solutions. Whether you're aiming for simplicity or fine-tuned control, Tanssi provides the tools and guidance to bring your vision to life. This section covers everything from selecting a template to customizing modules, testing, and deploying your network. | ||
|
||
## The Path to Deployment | ||
|
||
Deploying a network with Tanssi can be straightforward or highly customizable, depending on your requirements. The diagram below provides a clear breakdown of these options to guide your decision. | ||
|
||
```mermaid | ||
flowchart TD | ||
Start[Choose a template] | ||
Start --> Path1[Template is sufficient] | ||
Start --> Path2[Template needs customization] | ||
Path1 --> Deploy1[Deploy via Tanssi dApp] | ||
Path2 --> Fork[Fork the Tanssi repository] | ||
Fork --> Customize[Customize your network] | ||
Customize --> Test[Run tests] | ||
Test --> Deploy2[Deploy via Tanssi dApp] | ||
style Path1 fill:#151719,stroke:#4ecdc4,stroke-width:2px | ||
style Path2 fill:#151719,stroke:#4ecdc4,stroke-width:2px | ||
style Fork fill:#151719,stroke:#4ecdc4,stroke-width:2px | ||
style Customize fill:#151719,stroke:#4ecdc4,stroke-width:2px | ||
style Test fill:#151719,stroke:#4ecdc4,stroke-width:2px | ||
style Start fill:#151719,stroke:#4ecdc4,stroke-width:2px | ||
style Deploy1 fill:#151719,stroke:#4ecdc4,stroke-width:2px | ||
style Deploy2 fill:#151719,stroke:#4ecdc4,stroke-width:2px | ||
%% arrow style | ||
linkStyle default stroke-width:2px,stroke:#ccc | ||
``` | ||
|
||
Now that you’ve explored the deployment paths, the next step is to learn more about each template so you can choose the one that best fits your needs. To get started, check out the section below. | ||
|
||
## Explore What This Section Covers | ||
|
||
:::INSERT_GENERATED_CARDS::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
title: Appchain Templates | ||
title: Network Templates | ||
hide: false | ||
nav: | ||
- index.md | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,32 @@ | ||
--- | ||
title: Appchain Templates | ||
description: Learn more about the baseline appchain Templates (EVM and non-EVM) that support Tanssi out of the box to help you kickstart your appchain development. | ||
template: subsection-index-page.html | ||
hide: | ||
- toc | ||
- feedback | ||
title: Network Templates | ||
description: Learn more about the baseline network templates (EVM and non-EVM) that support Tanssi out of the box to help you kickstart your network development. | ||
icon: octicons-copy-24 | ||
template: index-page.html | ||
--- | ||
|
||
# Network Templates | ||
|
||
Kickstart your network development with our comprehensive templates. Designed for rapid deployment, these templates provide a strong foundation for both EVM and non-EVM solutions, accelerating your production journey. | ||
|
||
## Choosing the Right Template | ||
|
||
Selecting the right template is the first step in building your Tanssi-powered network. Whether you need a standard, fully customizable blockchain, or one that is EVM-compatible, both templates provide basic configurations, along with benefits like block production as a service, deterministic transaction finality, and the option to choose your security provider, such as [Symbiotic](https://symbiotic.fi/){target=\_blank}. | ||
|
||
**Baseline template:** | ||
|
||
- **Minimalistic design** - includes only the essential configurations for compatibility with Tanssi, making it an ideal base for adding custom modules | ||
- **Tailored runtime** - provides the flexibility to expand functionality by integrating existing or custom-built modules | ||
- **Highly configurable** - adapt the template to meet unique requirements for governance, economics, or consensus | ||
|
||
**Baseline EVM template:** | ||
|
||
- **Ready to deploy** - comes fully configured for Ethereum compatibility, requiring no runtime changes if the application is built on EVM | ||
- **Ethereum ecosystem integration** - supports Ethereum tools and libraries like [MetaMask](https://metamask.io){target=\_blank}, [Hardhat](https://hardhat.org/){target=\_blank}, [Foundry](https://book.getfoundry.sh/){target=\_blank}, and [Ethers.js](https://docs.ethers.org/){target=\_blank} | ||
- **Smart contract deployment** - deploy EVM smart contracts seamlessly using familiar tools | ||
|
||
Learn more about each template, the minimum requirements for your chain to function on Tanssi, and what modules are automatically included on the [Template Overview](/builders/build/templates/overview/) page. | ||
|
||
## Explore What This Section Covers | ||
|
||
:::INSERT_GENERATED_CARDS::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
title: Deploy Your Appchain | ||
title: Deploy Your Network | ||
hide: false | ||
nav: | ||
- index.md | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,31 @@ | ||
--- | ||
title: Deploy Your Appchain | ||
description: Learn how to deploy your appchain to Tanssi as a snap appchain for short-term testing or as a dedicated Tanssi appchain for long-term testing. | ||
template: subsection-index-page.html | ||
hide: | ||
- toc | ||
- feedback | ||
title: Deploy Your Network | ||
description: Learn how to deploy your network to Tanssi as a snap network for short-term testing or as a dedicated Tanssi network for long-term testing. | ||
template: index-page.html | ||
icon: octicons-rocket-24 | ||
--- | ||
|
||
# Deploy Your Network in Minutes | ||
|
||
With Tanssi, launching your network is straightforward and efficient. The platform simplifies the process, so you can focus on building your application. | ||
|
||
## Quick Overview of Deploying via the Tanssi DApp | ||
|
||
Deploying a Tanssi-powered network via the [Tanssi dApp](https://apps.tanssi.network){target=\_blank} is accomplished as a single, streamlined flow consisting of five distinct steps: | ||
|
||
1. Select a [template](/builders/build/templates/overview/){target=\_blank} and configure it | ||
2. Satisfy the required minimum token balances | ||
3. Reserve your Tanssi network ID on the relay chain | ||
4. Generate your custom network files | ||
5. Register your network on Tanssi, and the relay chain | ||
|
||
![A diagram mapping out the steps for deploying a Tanssi network with the Tanssi dApp.](/images/builders/deploy/dapp/dapp-2.webp) | ||
|
||
!!! note | ||
For [Snap networks and Dedicated networks](/builders/deploy/dapp/##snap-appchains-vs-dedicated-appchains) on the [Tanssi Dancebox TestNet](/builders/tanssi-network/testnet/dancebox/){target=\_blank}, the Tanssi team will manually complete verification. After verification, it typically takes about ten minutes for your Snap network to be ready and about two hours for a dedicated Tanssi network. For Tanssi MainNet, the process will be fully decentralized and permissionless. | ||
|
||
To get started, check out the Using the Tanssi DApp guide listed in the section below. | ||
|
||
## Explore What This Section Covers | ||
|
||
:::INSERT_GENERATED_CARDS::: |
Oops, something went wrong.