Skip to content

Commit

Permalink
Lukem/index page builders (#208)
Browse files Browse the repository at this point in the history
* 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
6 people authored Dec 20, 2024
1 parent 0da86ca commit 2f41f6a
Show file tree
Hide file tree
Showing 345 changed files with 1,090 additions and 373 deletions.
10 changes: 5 additions & 5 deletions .CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,18 +61,17 @@ Below is an example of an `index.md` file:
---
title: Build your Appchain
description: Install the software to compile yousr appchain, configure your genesis state and core functionalities, test locally and get ready to deploy through Tanssi.
template: subsection-index-page.html
hide:
- toc
- feedback
icon: octicons-code-24
template: index-page.html
---
```
Some important things to note:
- The `title` represents the `<title>` tag and is used for SEO purposes
- The `description` represents the meta-description and is also used for SEO purposes
- The `template` defines the template to be used. It should always be `main.html` for new content pages and `subsection-index-page.html` when adding a new section
- The `icon` is used on index pages (`index.md`). So it should be an icon representative of the content on the page. You should stick to using Octicons 24px icons. You can search through the available icons on the [Primer Design System website](https://primer.style/foundations/icons)
- The `template` defines the template to be used. It should always be `main.html` for new content pages and `index-page.html` when adding a new section
- The `<div>` is populated with links to any pages or subdirectories and is populated automatically by a script at runtime that builds the landing pages
## Content Pages
Expand All @@ -81,6 +80,7 @@ When adding a new content page, you should have the following components:
- **`title`** - represents the `<title>` tag and is used for SEO purposes (not displayed on the published site)
- **`description`** - represents the meta-description and is also used for SEO purposes (not displayed on the published site)
- **`icon`** - defines an icon to be used on the parent section's index page. It should be an icon representative of the content on the page. You should stick to using Octicons 24px icons. You can search through the available icons on the [Primer Design System website](https://primer.style/foundations/icons)
- **Page title** - a title to be displayed at the top of the page
- **`## Introduction` section** - 2-3 paragraphs to serve as an introduction. This should be long-lived, meaning it will not require changes in the future

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ To do so, take the following steps:
3. Provide your Tanssi appchain ID
4. Click on the **+** sign

![Getting the bootnode](/images/node-operators/appchain-node/rpc-docker-systemd-1.webp)
![Getting the bootnode](/images/node-operators/network-node/rpc-docker-systemd-1.webp)
1 change: 1 addition & 0 deletions builders/account-management/identity.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Set an Account Identity
description: Follow these step-by-step instructions to establish an identity, including a display name, so you can be more easily recognizable on Tanssi.
icon: octicons-person-24
---

# Set Up an Identity
Expand Down
16 changes: 12 additions & 4 deletions builders/account-management/index.md
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:::
1 change: 1 addition & 0 deletions builders/account-management/proxy-accounts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Set Up and Manage Proxy Accounts
description: Follow these step-by-step instructions to learn how proxies work and how to create, view, update, and remove proxy accounts from primary (proxied) accounts.
icon: octicons-shield-lock-24
---

# Proxy Accounts
Expand Down
2 changes: 1 addition & 1 deletion builders/build/.pages
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
Expand Down
2 changes: 1 addition & 1 deletion builders/build/customize/.pages
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
Expand Down
3 changes: 2 additions & 1 deletion builders/build/customize/adding-built-in-module.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Adding Built-in Substrate Modules
description: Substrate is a modular blockchain framework that includes many ready-to-use modules covering a wide range of common functionalities to include in your runtime.
description: Learn how to leverage Substrate's pre-built, ready-to-use modules to efficiently add new features to your network without building from scratch.
icon: octicons-package-24
---

# Adding a Built-in Module {: #adding-builtin-module }
Expand Down
3 changes: 2 additions & 1 deletion builders/build/customize/adding-custom-made-module.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Adding a Custom-Made Module
description: Substrate is a modular blockchain framework that makes it easy to build unique and innovative appchains composing built-in modules with custom-made ones.
description: Discover how to incorporate custom-made modules to add unique or specialized features to your network that go beyond the capabilities of the built-in modules.
icon: octicons-terminal-24
---

# Adding a Custom-Made Module {: #adding-custom-made-module }
Expand Down
3 changes: 2 additions & 1 deletion builders/build/customize/adding-external-module.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Adding External Modules
description: Learn how to manage and resolve double reference issues of dependencies when customizing your Tanssi appchain template with a Rust-based tool called Diener.
description: Use external modules that comes from third-party libraries or other sources outside the Substrate framework to expand your network's functionality.
icon: octicons-plug-24
---

# Adding an External Module {: #adding-external-module }
Expand Down
3 changes: 2 additions & 1 deletion builders/build/customize/customizing-chain-specs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Customizing Chain Specifications
description: The chain specification contains the initial parameters required for launching a new Tanssi appchain, including genesis state, token configuration, and more.
description: Review the sections and attributes of a chain specification file and how to obtain it for launching your Tanssi-powered network with a customized specification.
icon: octicons-link-24
---

# Customizing Chain Specifications {: #customizing-chain-specifications }
Expand Down
41 changes: 35 additions & 6 deletions builders/build/customize/index.md
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:::
1 change: 1 addition & 0 deletions builders/build/customize/prerequisites.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Prerequisites for Building an Appchain
description: Install the basic set of tools and software to set up a local development environment and be able to compile, run, and test your appchain.
icon: octicons-checkbox-24
---

# Prerequisites for Building an Appchain {: #prerequisites }
Expand Down
50 changes: 44 additions & 6 deletions builders/build/index.md
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:::
2 changes: 1 addition & 1 deletion builders/build/templates/.pages
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
Expand Down
1 change: 1 addition & 0 deletions builders/build/templates/custom-runtime.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Custom Runtime
description: Any custom runtime can be adapted to be deployed through Tanssi, provided that specific modules are implemented and the required configurations are set.
icon: octicons-file-binary-24
---

# Custom Runtime
Expand Down
1 change: 1 addition & 0 deletions builders/build/templates/evm.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Baseline EVM Template
description: The Tanssi repository includes an EVM template that provides all the necessary configurations to launch an appchain that is fully compatible with Ethereum.
icon: material-ethereum
---

# Baseline EVM Template {: #baseline-evm-template }
Expand Down
36 changes: 30 additions & 6 deletions builders/build/templates/index.md
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:::
1 change: 1 addition & 0 deletions builders/build/templates/overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Templates
description: Tanssi includes templates to kick-start the development of an appchain offering options such as a basic one and another featuring full EVM (Ethereum) support.
icon: octicons-home-24
---

# Templates Overview {: #templates-overview }
Expand Down
1 change: 1 addition & 0 deletions builders/build/templates/substrate.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Baseline Appchain Template
description: The Tanssi repository includes a basic template that provides the necessary configuration to support the protocol and kick-start the development of an appchain.
icon: simple-paritysubstrate
---

# Baseline Appchain Template {: #baseline-appchain-template }
Expand Down
2 changes: 1 addition & 1 deletion builders/deploy/.pages
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
Expand Down
17 changes: 2 additions & 15 deletions builders/deploy/dapp.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Deploy Your Appchain via the DApp
description: Learn how to spin up and deploy an appchain on Tanssi in minutes using the Tanssi dApp, a no-code solution for onboarding into the Polkadot ecosystem.
icon: octicons-browser-24
---

# Deploy your Appchain via the Tanssi DApp
Expand All @@ -25,20 +26,6 @@ The screenshots and content in this guide will showcase Snap appchains, but you

![A screenshot showing the initial dashboard of apps.tanssi.network.](/images/builders/deploy/dapp/dapp-1.webp)

## Overview {: #overview }

Deploying a Tanssi appchain via the Tanssi dApp 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 appchain ID on the relay chain
4. Generate your custom appchain files
5. Register your appchain on Tanssi, and the relay chain

![A diagram mapping out the steps for deploying a Tanssi appchain with the Tanssi dApp.](/images/builders/deploy/dapp/dapp-2.webp)

For Snap appchains and 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 appchain to be ready and about two hours for a dedicated Tanssi appchain. For Tanssi MainNet, the process will be fully decentralized and permissionless.

## Prerequisites {: #prerequisites }

### Supported Wallets {: #supported-wallets }
Expand Down Expand Up @@ -265,4 +252,4 @@ Once the transaction has gone through successfully, the dApp will update to show

![The appchain dashboard on the Tanssi dApp.](/images/builders/deploy/dapp/dapp-14.webp)

And that's it! You've successfully registered your Tanssi appchain! The launch process will automatically begin once the Tanssi team has verified your Tanssi appchain. Once your Tanssi appchain is live, you can return to the **Dashboard** to view the RPC URL and other pertinent chain information.
And that's it! You've successfully registered your Tanssi appchain! For Snap appchains and 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 appchain to be ready and about two hours for a dedicated Tanssi appchain. For Tanssi MainNet, the process will be fully decentralized and permissionless. Once your Tanssi appchain is live, you can return to the **Dashboard** to view the RPC URL and other pertinent chain information.
35 changes: 29 additions & 6 deletions builders/deploy/index.md
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:::
Loading

0 comments on commit 2f41f6a

Please sign in to comment.