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

Reorganization of the New Index Pages #215

Merged
merged 19 commits into from
Jan 3, 2025
Merged
Show file tree
Hide file tree
Changes from 17 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
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 Decentralized Network
description: Install the software to compile your decentralized network, 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
3 changes: 3 additions & 0 deletions .pages
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@ nav:
- builders
- node-operators
- learn
- About:
- 'About Tanssi': 'https://www.tanssi.network/'
- 'Tanssi TestNet': 'https://apps.tanssi.network/dancebox'
Original file line number Diff line number Diff line change
@@ -1 +1 @@
- `Bootnode` - a bootnode is a full archive node that is used to sync the network from scratch. You'll need to [retrieve your Tanssi network bootnode](#fetching-bootnode-information) and replace `INSERT_YOUR_NETWORK_BOOTNODE` with the actual bootnode information
- `Bootnode` - a bootnode is a full archive node that is used to sync the network from scratch. You'll need to [retrieve your Tanssi network bootnode](#fetching-bootnode-information) and replace `INSERT_YOUR_NETWORK_BOOTNODE` with the actual bootnode information
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 Decentralized Network
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 Decentralized Network
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 networks 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
1 change: 1 addition & 0 deletions 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 resolve double reference issues of dependencies when customizing your Tanssi-powered network template with a Rust-based tool called Diener.
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 network, 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
39 changes: 34 additions & 5 deletions builders/build/customize/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,37 @@
---
title: Customize Your Network
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.
template: subsection-index-page.html
hide:
- toc
- feedback
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:::
3 changes: 2 additions & 1 deletion builders/build/customize/prerequisites.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Prerequisites for Building a Network
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 network.
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 a Network {: #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 Decentralized Network
description: Install the software to compile your Tanssi-powered network, configure your genesis state and core functionalities, test locally, and prepare to deploy.
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](/builders/build/templates) so you can choose the one that best fits your needs.

## Explore What This Section Covers

:::INSERT_GENERATED_CARDS:::
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 a network that is fully compatible with Ethereum.
icon: material-ethereum
---

# Baseline EVM Template {: #baseline-evm-template }
Expand Down
23 changes: 18 additions & 5 deletions builders/build/templates/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,21 @@
---
title: Network Templates
description: Learn more about the baseline Templates (EVM and non-EVM) Tanssi provides out of the box to help you kickstart your Tanssi-powered network development.
template: subsection-index-page.html
hide:
- toc
- feedback
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.

As presented in the [Network Templates Included in Tanssi](/learn/networks/included-templates/){target=\_blank} page from the Learn section, Tanssi already provides two templates to jumpstart the development process:

- **[Baseline Tanssi network template](/learn/networks/included-templates#baseline-network-template){target=\_blank}** - a template that provides the basic platform to start adding custom logic
- **[Baseline Tanssi EVM (Ethereum Virtual Machine) network template](/learn/networks/included-templates/#baseline-evm-template){target=\_blank}** - a template that provides full Ethereum compatibility

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:::
22 changes: 17 additions & 5 deletions builders/build/templates/overview.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,30 @@
---
title: Templates
description: Tanssi includes templates to kick-start the development of decentralized networks, offering options such as one featuring full EVM (Ethereum) compatibility.
description: Tanssi includes templates to kick-start the development of a network offering options such as a basic one and another featuring full EVM (Ethereum) support.
icon: octicons-home-24
---

# Templates Overview {: #templates-overview }

## Introduction {: #introduction }

Networks deployed through Tanssi are fully customizable blockchains benefiting from a shared set of sequencers and the security of a provider of their choice (for example, [Symbiotic](https://symbiotic.fi/){target=\_blank} for Ethereum). They also need to implement the necessary functionalities and configurations to support the Tanssi protocol, which the templates presented in this article already do, making it easier for developers.
Networks deployed through Tanssi are fully customizable blockchains benefiting from a shared set of sequencers and the security of a provider of their choice. The templates presented in this article implement the necessary functionalities and configurations to support the Tanssi protocol, making development easier.

As presented in the [Included Templates](/learn/decentralized-networks/included-templates/#baseline-network-template){target=\_blank} from the Learn section, Tanssi already provides two templates to jumpstart the development process:
## Choosing the Right Template

- **[Baseline Tanssi network template](/learn/decentralized-networks/included-templates#baseline-network-template){target=\_blank}** - a template that provides the basic platform to start adding custom logic
- **[Baseline Tanssi EVM (Ethereum Virtual Machine) network template](/learn/decentralized-networks/included-templates/#baseline-evm-template){target=\_blank}** - a template that provides full Ethereum compatibility
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

In this article, the required base setup and how to use the templates as a starting point to start building your Tanssi network are presented.

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 Network Template
description: The Tanssi repository includes a basic template that provides the necessary configuration to support the protocol and kick-start the development of a network.
icon: simple-paritysubstrate
---

# Baseline Network Template {: #baseline-network-template }
Expand Down
15 changes: 1 addition & 14 deletions builders/deploy/dapp.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Deploy Your Network via the DApp
description: Learn how to spin up and deploy a network on Tanssi in minutes using the Tanssi dApp, a no-code solution for onboarding and launching decentralized networks.
icon: octicons-browser-24
---

# Deploy your Network via the Tanssi DApp
Expand All @@ -25,20 +26,6 @@ The screenshots and content in this guide will showcase quick trial networks, bu

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

## Overview {: #overview }

Deploying a Tanssi network 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 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)

For quick trial networks and Dedicated networks 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 quick trial network to be ready and about two hours for a dedicated Tanssi network. For Tanssi MainNet, the process will be fully decentralized and permissionless.

## Prerequisites {: #prerequisites }

### Supported Wallets {: #supported-wallets }
Expand Down
31 changes: 27 additions & 4 deletions builders/deploy/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,31 @@
---
title: Deploy Your Network
description: Learn how to deploy your network to Tanssi as a quick trial for short-term testing or as a dedicated network for long-term testing using the Tanssi dApp.
template: subsection-index-page.html
hide:
- toc
- feedback
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_ 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, visit [Using the Tanssi DApp](/builders/deploy/dapp/).

## Explore What This Section Covers

:::INSERT_GENERATED_CARDS:::
Loading