Skip to content

Commit

Permalink
Merge pull request #122 from w3f/intro-parachain
Browse files Browse the repository at this point in the history
Parachain Intro Refactor
  • Loading branch information
CrackTheCode016 authored Oct 12, 2023
2 parents e88502f + 23221be commit eb0afbd
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/Parachain/beginner/section4/road-to-production.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,4 +90,4 @@ If you get stuck on a technical issue, make sure to ask on
acquainted with the protocol ready to answer any technical questions.

If you want to get feedback for an idea or consult the wider ecosystem, feel free to post on the
[Polkadot Forum](https://forum.polkadot.network/).
[Polkadot Forum](https://forum.polkadot.network/).
50 changes: 44 additions & 6 deletions docs/introparachain.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,51 @@ sidebar_position: 1

# Parachain Development Guide

This guide aims to jumpstart a developer from an overview of Polkadot architecture, creating their
own parachain, and going through the process of registering it to a locally available relay chain.
This guide aims to jumpstart the process of developing and deploying parachains on Polkadot. This guide covers an overview of Polkadot architecture, creating your own parachain, and going through the process of registering it to a locally available relay chain. It contains both a brief yet demystifying explanation of Polkadot and how various roles work together to provide data availability, interoperability, and shared security. This guide also offers practical steps to begin parachain development, as well as offers different potential workflows for how to develop and test a parachain locally.

- Learn the basics of how Polkadot works as a network.
If you wish to only learn about the current relay chain and parachain architecture, then you only need to read the [first section](./Parachain/beginner/section1/index.md). Otherwise, this guide also provides the means to begin your parachain development journey.

:::tip Suggested Prerequisite/Complementary Reading

The following courses, or knowledge of these subjects in general will aid you in smoothly following this guide. As FRAME and Substrate are inevitable to know if you wish to modify and customize your parachain, the following courses cover highly useful material for this purpose:

1. [Intro to Rust](./introrust.md)
2. [Intro to Substrate](./introsubstrate.md)

* [**Rust**](https://www.rust-lang.org/tools/install) should already be installed on your system
* For a smoother start, clone the [Parachain Guide Resources](https://github.com/w3f/parachain-guide-resources) repository

:::

The primary goals are:

- Learn the basics of how Polkadot works as an **execution sharded** network.
- Learn the roles of the relay and parachain architecture.
- Install necessary binaries and dependencies needed to create networks locally.
- Modify your parachain and prep it for connecting to the relay chain.
- Create a parathread and reserve a para ID
- Create and run an auction, registering your parachain.
- Next steps and moving forward.
- Create a parathread and reserve a para ID.
- Regiseter your parachain using the `sudo` pallet.
- Next steps and moving forward in deployment and production **(coming soon)**.

## Section 1 - Network Architecture

- [Polkadot Network Components](./Parachain/beginner/section1/network-components.md)
- [Parachain Architecture Overview](./Parachain/beginner/section1/parachain.md)
- [Relay Chain Architecture Overview](./Parachain/beginner/section1/relay-chain.md)

## Section 2 - Installing & Running Dependencies

- [Install Local Binaries](./Parachain/beginner/section2/install-binary.md)
- [Install the Cumulus Parachain Template](./Parachain/beginner/section2/install-template.md)
- [Running the Relay and Parachain](./Parachain/beginner/section2/running-chains.md)

## Section 3 - Registering Your Parachain

- [Creating a Parathread](./Parachain/beginner/section3/creating-parathread.md)
- [Registering Your Parachain with Sudo](./Parachain/beginner/section3/sudo-register.md)
- [Developing Your Parachain](./Parachain/beginner/section3/developing-parachain.md)

## Section 4 - Next Steps (coming soon)

- [Ecosystem Initiatives](./Parachain/beginner/section4/initatives.md)
- [Road to Production](./Parachain/beginner/section4/road-to-production.md)

0 comments on commit eb0afbd

Please sign in to comment.