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

Lukem/index page learn #212

Merged
merged 25 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from 23 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
24ac421
workflow fix
Nov 27, 2024
b899deb
resolve workflow issue
Nov 27, 2024
0da86ca
Merge pull request #206 from ilariae/main
albertov19 Nov 27, 2024
de6ca02
Hides XCM related articles
augustocollado Dec 2, 2024
1d021c3
Hides XCM from the learn section
augustocollado Dec 2, 2024
9c59d74
Merge pull request #209 from moondance-labs/augustocollado/hide-xcm-r…
augustocollado Dec 3, 2024
ca1ac11
learn general index update
0xlukem Dec 10, 2024
f9a44ca
update index appchain test
0xlukem Dec 10, 2024
9aec95d
update appchain index
0xlukem Dec 10, 2024
f367dba
update index tanssi
0xlukem Dec 10, 2024
df085a1
update network features index
0xlukem Dec 10, 2024
e760e16
Merge branch 'main' into lukem/index-page-Learn
0xlukem Dec 10, 2024
4d4a0d0
add icons to tanssi index
0xlukem Dec 11, 2024
db50029
add icons to framework index
0xlukem Dec 11, 2024
8df508e
fix overview icons and add icons to appchains index
0xlukem Dec 11, 2024
854e39e
fix typo index learn
0xlukem Dec 11, 2024
f4e9a3b
rearrange Learn Index and add missing icons to index pages
0xlukem Dec 11, 2024
54f7f25
Apply suggestions from code review
0xlukem Dec 11, 2024
1310627
Add changes according to feedback
0xlukem Dec 12, 2024
550edbb
Update learn/index.md
0xlukem Dec 16, 2024
24ef128
changes according to the latest feedback
0xlukem Dec 16, 2024
44803c9
Apply suggestions from code review
0xlukem Dec 18, 2024
5c639f2
change words appchains for networks in index
0xlukem Dec 18, 2024
5dc6423
Apply suggestions from code review
0xlukem Dec 19, 2024
7aa1c1b
Lukem/index page node (#214)
0xlukem Dec 20, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .github/workflows/check-mkdocs-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ jobs:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v5
with:
python-version: '3.10.12'

- name: Allow to move dotfiles
run: |
Expand All @@ -24,7 +27,7 @@ jobs:
- name: Move tanssi-docs contents to mkdocs repository
run: |
mkdir tanssi-mkdocs/tanssi-docs
mv * tanssi-mkdocs/tanssi-docs &> /dev/null || echo "Error with mv expected due to recursively moving all contents into subfolder"
find . -mindepth 1 -maxdepth 1 ! -name 'tanssi-mkdocs' -exec mv {} tanssi-mkdocs/tanssi-docs/ \;

- name: Install pip requirements
run: |
Expand Down
2 changes: 2 additions & 0 deletions builders/manage/dapp/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,5 @@ nav:
- index.md
- 'Block Production Services Payment': 'services-payment.md'
- 'Manage Tokens': 'manage-tokens.md'
# - 'Manage Cross-Chain Communication Channels': 'xcm-channels.md'
# - 'Register External Assets': 'register-external-assets.md'
2 changes: 2 additions & 0 deletions builders/toolkit/ethereum-api/precompiles/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,6 @@ nav:
- 'Batch': batch.md
- 'Call Permit': call-permit.md
- 'Native Token ERC-20': erc20.md
# - 'Cross Chain Transfers': cross-chain-transfers.md
# - 'External Assets as ERC-20': external-assets-erc20.md
- 'Proxy': proxy.md
2 changes: 1 addition & 1 deletion learn/appchains/.pages
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
title: Appchains in Tanssi
title: Tanssi-Powered Networks
hide: false
nav:
- index.md
Expand Down
23 changes: 17 additions & 6 deletions learn/appchains/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,20 @@
---
title: Appchain
description: Discover the features in EVM and Substrate appchains deployed through Tanssi, leveraging user-friendly and easy-to-deploy templates for enhanced capabilities.
template: subsection-index-page.html
hide:
- toc
- feedback
title: Learn about Tanssi-Powered Networks
description: Discover the features in EVM and Substrate networks deployed through Tanssi, leveraging user-friendly and easy-to-deploy templates for enhanced capabilities.
icon: octicons-workflow-24
template: index-page.html
---

# Tanssi-Powered Networks

Developing a blockchain that balances scalability, efficiency, and customization is a complex task. Tanssi-Powered Networks address these challenges through their integration into Tanssi's modular infrastructure. This section explains the networks' structure, functionality, and unique characteristics in the Tanssi ecosystem.

Key features of Tanssi-Powered Networks:
0xlukem marked this conversation as resolved.
Show resolved Hide resolved

- **Runtime customization** - adapt transaction types, execution logic, and state transitions to fit your network's specific requirements
- **Transaction efficiency** - optimize transaction fees for scalability and economic sustainability
- **Scalability at its core** - build networks that are prepared to grow alongside your ecosystem

## Explore What This Section Covers

:::INSERT_GENERATED_CARDS:::
eshaben marked this conversation as resolved.
Show resolved Hide resolved
1 change: 1 addition & 0 deletions learn/appchains/overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Appchain Overview
description: Learn the high-level definitions of how a Tanssi appchain works, its architecture, and its block production as a service mechanism with deterministic finality.
icon: octicons-home-24
---

# Tanssi Appchains Overview {: #appchains-tanssi-overview }
Expand Down
1 change: 1 addition & 0 deletions learn/appchains/runtime-features.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Core Runtime Features
description: Learn about the core features of a Tanssi appchain, the transactions types, how they are executed and included in a block, and the forkless runtime upgrades
icon: octicons-package-24
---

# Core Runtime Features {: #core-runtime-features }
Expand Down
3 changes: 2 additions & 1 deletion learn/appchains/tx-fees.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Transaction Fees
description: Learn about the transaction fee mechanism in Tanssi appchains, how it works from a Substrate perspective, and in the Ethereum EVM emulation layer with EIP-1559.
description: Learn about the transaction fee mechanism in Tanssi networks, how it works from a Substrate perspective, and in the Ethereum EVM emulation layer with EIP-1559.
icon: material-piggy-bank-outline
eshaben marked this conversation as resolved.
Show resolved Hide resolved
---

# Transaction Fees {: #transaction-fees }
Expand Down
4 changes: 2 additions & 2 deletions learn/framework/.pages
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
title: Appchain Development Framework
title: Network Development Framework
hide: false
nav:
- index.md
- 'Overview': 'overview.md'
- 'Framework Architecture': 'architecture.md'
- 'Modularity': 'modules.md'
- 'Native Cross-Chain Communication': 'xcm.md'
# - 'Native Cross-Chain Communication': 'xcm.md'
1 change: 1 addition & 0 deletions learn/framework/architecture.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Framework Architecture
description: In a Substrate node, two main components are the runtime, which controls the blockchain's state transition, and the client, which manages everything else.
icon: octicons-stack-24
---

# Framework Architecture {: #framework-architecture }
Expand Down
24 changes: 19 additions & 5 deletions learn/framework/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,23 @@
---
title: Appchain Development Framework
description: Learn about the appchain Development Framework, Rust Programming Language, Substrate and its features, including XCM and ready-to-use pallets for your Runtime.
template: subsection-index-page.html
hide:
- toc
- feedback
description: Learn about the network Development Framework, Rust Programming Language, Substrate and its features, including XCM and ready-to-use pallets for your Runtime.
0xlukem marked this conversation as resolved.
Show resolved Hide resolved
icon: octicons-code-24
template: index-page.html
---

# Network Development Framework

Building a blockchain from scratch is an intricate process that demands deep knowledge of consensus algorithms, cryptography, data structures, governance, and more. Tanssi simplifies this process by leveraging Substrate, a powerful blockchain development framework that provides all the essential components for creating customized blockchains.

With Substrate’s modular architecture, you can modify runtime characteristics, integrate pre-built modules, or develop new ones based on your network’s specific needs. Tanssi provides the foundation you need to bring your blockchain vision to life.

Key Features of the framework:
0xlukem marked this conversation as resolved.
Show resolved Hide resolved

- **Substrate core architecture** - divided into the _core client_, which manages external communications and internal responsibilities like storage, and the _runtime_, which executes transactions and manages state transitions with customizable logic
- **End-user simplicity** - the internal workings of the framework are abstracted for end-users, ensuring seamless interaction through dApps or via RPC endpoints, such as those used by wallets
- **Modular system design** - incorporate pre-built modules or create custom ones to meet specific needs
- **Developer-centric flexibility** - focus on runtime characteristics and use case specifics, allowing you to create a blockchain tailored to your vision without unnecessary complexity

## Explore What This Section Covers

:::INSERT_GENERATED_CARDS:::
1 change: 1 addition & 0 deletions learn/framework/modules.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Appchain Modules for your Runtime
description: Substrate is a modular blockchain development framework with an extensive set of ready-to-use components to bundle with custom logic into the appchain Runtime.
icon: material-puzzle-outline
---

# Appchain Framework Modules {: #appchain-framework-modules }
Expand Down
1 change: 1 addition & 0 deletions learn/framework/overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Appchain Development Framework Overview
description: Substrate is a blockchain development framework built in Rust Programming Language that streamlines and speeds up the process of developing new appchains.
icon: octicons-home-24
---

# Appchain Development Framework Overview {: #appchain-dev-framework-overview }
Expand Down
31 changes: 27 additions & 4 deletions learn/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,31 @@
---
eshaben marked this conversation as resolved.
Show resolved Hide resolved
title: Learn About Tanssi Infrastructure Protocol
description: Learn about Tanssi protocol and how it helps developers to build and deploy appchains by handling infrastructure complexities and providing key integrations.
description: Learn about Tanssi protocol and how it helps developers to build and deploy networks by handling infrastructure complexities and providing key integrations.
template: index-page.html
hide:
- toc
- feedback
---

# Learn

Launching a decentralized network has traditionally been a challenging and time-consuming process, requiring expertise in infrastructure, security, and operational setup. Tanssi simplifies this journey by removing the complexities and making network deployment fast and accessible. With Tanssi, developers can rely on seamless block production, integration with essential tools, and the flexibility to choose security providers that best fit their blockchain environment, empowering them to focus on innovation rather than technical hurdles.

This section explores the core elements that define Tanssi as a leading solution for network development. From its modular framework and runtime customization to transaction management and interoperability, Tanssi transforms network development into an accessible and efficient process, drastically reducing time to market while ensuring high performance and scalability.

0xlukem marked this conversation as resolved.
Show resolved Hide resolved
Whether you’re starting your journey into decentralized networks or deepening your understanding of Tanssi’s unique capabilities, these documents provide everything you need to understand how Tanssi sets a new standard for network infrastructure.

## Explore What This Section Covers

:::INSERT_GENERATED_CARDS:::

## Want to Jump Right into the Action?

<div class="subsection-wrapper">
<div class="card">
<a href="/builders/build/">
<div class="card-header">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M11.03 2.59a1.501 1.501 0 0 1 1.94 0l7.5 6.363a1.5 1.5 0 0 1 .53 1.144V19.5a1.5 1.5 0 0 1-1.5 1.5h-5.75a.75.75 0 0 1-.75-.75V14h-2v6.25a.75.75 0 0 1-.75.75H4.5A1.5 1.5 0 0 1 3 19.5v-9.403c0-.44.194-.859.53-1.144ZM12 3.734l-7.5 6.363V19.5h5v-6.25a.75.75 0 0 1 .75-.75h3.5a.75.75 0 0 1 .75.75v6.25h5v-9.403Z"></path></svg>
eshaben marked this conversation as resolved.
Show resolved Hide resolved
<h2 class="title">Build Your Network</h2>
</div>
<p class="description">Learn how to design and customize your network with ready-to-use templates and tools tailored to your technical needs.</p>
</a>
</div>
</div>
1 change: 1 addition & 0 deletions learn/tanssi/included-templates.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Appchain Templates Included in Tanssi
description: Tanssi protocol provides useful templates to start building your appchain, including a ready-to-use EVM template for Ethereum compatibility.
icon: octicons-copy-24
---

# Appchain Templates Included in Tanssi {: #appchain-templates-included-in-tanssi }
Expand Down
23 changes: 18 additions & 5 deletions learn/tanssi/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,21 @@
---
title: Learn About Tanssi
description: Learn about Tanssi protocol and how it handles infrastructure complexities, making it easy for new appchains to be deployed in the Polkadot Web3 ecosystem.
template: subsection-index-page.html
hide:
- toc
- feedback
description: Learn about Tanssi protocol and how it handles infrastructure complexities, making it easy for new networks to be deployed in the Polkadot Web3 ecosystem.
icon: octicons-star-24
template: index-page.html
---

# Learn About Tanssi

Here, you'll find an overview of Tanssi’s core capabilities that support network development, covering everything from infrastructure and security to essential integrations.

Key features that set Tanssi apart:

- **Block production as a service** - Tanssi’s incentivized block producers ensure reliable block creation and network liveness, removing the operational burden from developers
- **Flexible security providers** - choose security solutions tailored to your Tanssi-powered network environment, such as Symbiotic for Ethereum-based chains, enabling shared security without sourcing economic guarantees
- **Time-to-market efficiency** - launch networks in minutes with Tanssi’s comprehensive approach to infrastructure and security, significantly reducing development time
- **Seamless integrations** - Tanssi provides out-of-the-box infrastructure, including wallets, RPC endpoints, and block explorers, streamlining network deployment

## Explore What This Section Covers

:::INSERT_GENERATED_CARDS:::
0xlukem marked this conversation as resolved.
Show resolved Hide resolved
16 changes: 11 additions & 5 deletions learn/tanssi/network-features/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
---
title: Network Features
description: Learn about Tanssi general network features such as Staking, Governance and Treasury, and how each help Tanssi becoming a fully decentralized Appchain orchestrator for the Web3 ecosystem.
template: subsection-index-page.html
hide:
- toc
- feedback
description: Learn about Tanssi general network features such as staking, governance, and treasury, and how each help Tanssi becoming a fully decentralized network orchestrator for the Web3 ecosystem.
0xlukem marked this conversation as resolved.
Show resolved Hide resolved
icon: octicons-cpu-24
template: index-page.html
---

# Network Features

The network features in Tanssi are designed to provide the foundational mechanisms that support decentralization, security, and scalability. From securing networks through staking to future capabilities, this section outlines the core elements that empower Tanssi’s network infrastructure.

## Explore What This Section Covers

:::INSERT_GENERATED_CARDS:::
1 change: 1 addition & 0 deletions learn/tanssi/network-features/staking.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Staking
description: Learn how Tanssi implements a novel Staking mechanism to provide a decentralized and trustless set of block producers to all Tanssi-powered appchains
icon: material-hand-coin-outline
---

# Tanssi Staking {: #tanssi-staking }
Expand Down
1 change: 1 addition & 0 deletions learn/tanssi/overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Overview
description: Tanssi is an appchain protocol that eases the process of deploying appchains so that developers can focus on their custom application logic.
icon: octicons-home-24
---

# What is Tanssi? {: #what-is-tanssi }
Expand Down
1 change: 1 addition & 0 deletions learn/tanssi/technical-features.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Block Production Services
description: Tanssi provides block production services assigning block producers to the appchains, requiring minimal changes to the code for appchains to be deployed.
icon: octicons-gear-24
---

# Technical Features of Tanssi {: #technical-features-of-tanssi }
Expand Down