[Draft] Polkadot Development Overview (build) #4810

CrackTheCode016 · 2023-05-17T23:24:12Z

Creating a development "funnel" that clarifies the paths one can take in order to start developing on Polkadot. It is not meant to be a guide for everything, rather a concise series of pointers to necessary content oriented for builders.

This PR was created mainly because there has been a lack of clarity for some of those who are new to the ecosystem but wish to either simply tinker with Polkadot or dive into it at a more professional level.

Broad goals:

Clarify the role of Polkadot versus parachains from a dev POV
Discuss the various paradigms and provide direction depending on the paradigm chosen
Clarify the differences and relationships between key development tools within the Polkadot ecosystem:
- Substrate, Cumulus, and FRAME clarity and the output of each component
- Creating parachains versus solo chains
- Direct pallet versus smart contract comparison
Links galore - provide links to everything
Graphics / diagrams to showcase the differences and outcomes of each choice

kianenigma · 2023-05-23T20:21:47Z

You will probably find this useful:

https://forum.parity.io/t/polkadot-substrate-cumulus-host-runtime-all-in-one-diagram/1836

And

https://mermaid.live/edit#pako:eNplU9uOmzAQ_RXXUpSXQAmXSMvDSpRtJarQRDgoq0IeHHAaq2Ajx1abRfx7HdhuSDKSJWZ8zlwO4xYWvCTQhzmbTFrKqPRBO5VHUpOpP2VESYGraddNJjnL2aHif4ojFhIsk5wBbSe1_yVwcwQrpi8oG6IXQ5vsSxq9LHfAMJ4BCjNUX4ghZzplIXdX5IgT9uCI_f70EES8oiWV53xU46N6jE-SCLBRkguKqyti6KRPkGTbAMUgUUzSmgADfEuC-OvutoOLJT18HSRBtgVIj0tKgEihhK6uaaGqVaVOowEIK8ddDXy0Wq6y7efVfYZ3nua8l70X8nDolRzLMgyQBlkaNI1uAdW8KvlYwzToIWGwjh6C6-8o0wfou0cGUvvXzajU1b3vMPqxySKmZeYNEXhPq0GO1zDefQAM0zSeUXjrJ7duGuQMzmBNRI1pqVevvdznsF-6HPr6syQHrCqZ663sNBTr34rOrIC-FIrMoGpKLMkLxVqx-n-wwewn52MX-i38C33PMT3HffLm9sJZ2E-e687gGfqONTdty7F0wJ7bruN2M_jWJ7BMz-pt7tiOu7A8TSB69biIh7fSP5nuH4i756U

kianenigma · 2023-05-23T20:24:51Z

I would love to review this when final. The message here is crucial and we should adjust. This type of low level work can also use the opinion of a multitude of people, as it will be an important message. Who is --sort of-- the master mind behind the existing plan?

On which page of the Polkadot website will this be hosted?

Looking at the figure, one issue that I can spot is that you are using Slot instead of Core.

CrackTheCode016 · 2023-05-24T12:55:52Z

I would love to review this when final. The message here is crucial and we should adjust. This type of low level work can also use the opinion of a multitude of people, as it will be an important message. Who is --sort of-- the master mind behind the existing plan?

I believe it was one of the previous TechEd for the most current iteration, although I believe there were several peopel working on it over the years (@DrW3RK could clarify more probably).

On which page of the Polkadot website will this be hosted?

For reference, this page currently lives here: https://wiki.polkadot.network/docs/build-guide. My hope is that it can serve as as good reference for any other pages which may benefit from defining these paths to development.

I would love to review this when final. The message here is crucial and we should adjust. This type of low level work can also use the opinion of a multitude of people

@kianenigma Once it is final, I'll request a review :) I agree, it is something that needs a lot more input and thought from everyone! And thank you for those resources, will implement them accordingly.

CrackTheCode016 · 2023-05-24T15:39:50Z

Added some more content, removed repetitive stuff, and added the notion of four tracks:

[Building Parachains]
[Building a Pallet] (incomplete)
[Developing Smart Contracts]
[Developing a dApp] (incomplete)

Generally, I think a developer who (assuming knows nothing) could now more easily discern where they should go for learning depending on their goals.

Some more graphics would be nice, as well as making sure it flows well.

filippoweb3

Added conditional rendering, I noticed that there are still places with "Polkadot or Kusama". As the page is used for both wikis we need to make sure cponditional rendering is present.

docs/build/build-guide.md

filippoweb3

Added conditional rendering, I noticed that there are still places with "Polkadot or Kusama". As the page is used for both wikis we need to make sure cponditional rendering is present.

kianenigma · 2023-06-01T14:37:39Z

docs/build/build-guide.md

+
+## Development Ecosystem Overview
+
+![Path to Building a Parachain](../assets/parachain-development.png)


I find this figure a bit convoluted. Especially the lines linking things to the cumulus box is unclear to me. Can you explain further?

The idea was to sort of show the relationships between various components, and how one could morph from one to another. Pallets make up your custom runtime -> Which are used by FRAME -> Which are both built on Substrate.

The Cumulus part was to also show that really, they are all concluded as a runtime no matter the path you take (parachain or solo chain).

I'll work on making t clearer, probably a top-down approach is better 👍

Any updates on this?

I will be working on it early next week - the education repo has been taking my time :)

I'll request your review when I complete the last set of changes 👍

Actually, it seems a lot of that repo may be relevant here! I'll probably tag you in some of the diagrams I'm putting together over there :) Mostly to do with frame and their relationship with Substrate core libraries, that kind of stuff

Working diagram - I think it's clearer than the other one so far. Goal was to make it super clear what does what, and how they relate to one another

If something like this is good, then I can theme it

edit: themed.

I am seeing this with a lot of delay, but the outcome is great, thanks!

kianenigma · 2023-06-01T14:38:54Z

docs/build/build-guide.md

+Kusama, or even as a basis to form a conventional layer one solo chain.
+
+Currently, the most streamlined way of utilizing Substrate is
+[FRAME](https://docs.substrate.io/learn/runtime-development/#frame), which conveniently allows for a


In the future, we should try and gradually reduce links to docs.substrate.io and instead rely more and more on our RUST-docs in the short term, and in the long term (paritytech.github.io) on the new doc portal.

That'd be awesome. Right now, the only equivalent to those docs in the Rust docs is this one as far as I know 😅 https://paritytech.github.io/substrate/master/frame_support/macro.construct_runtime.html

Once https://github.com/paritytech/substrate/pull/14137/files is done, we can use it here :)

kianenigma · 2023-06-01T14:40:17Z

docs/build/build-guide.md

+Substrate chains. It consists of a development server and fluent API, which facilitates multichain
+interactions without compromising either performance or ease of use. </TabItem>
+
+<TabItem value="subxt"> Submit extrinsics (transactions) to a Substrate node via RPC using Rust.


CrackTheCode016 · 2023-06-02T13:08:58Z

@filippoweb3 addressed

Co-authored-by: Filippo <110459737+filippoweb3@users.noreply.github.com>

CrackTheCode016 · 2023-06-22T15:23:03Z

@kianenigma @DrW3RK @filippoweb3 I have polished and simplified this page and have a working diagram for the overall ecosystem development path.

Some things to consider:

There is a lot of info. Is there too much info? Do you think it should be more concise?
Do the current tracks need changing? Are these what people should be looking for / to do when first coming to Polkadot?
Who else could weigh in on an opinion here, as mentioned, this should and does require more than one party's input.

filippoweb3

lgtm, but I am probably not the best person to approve this PR as I still lack some knowledge about dev. Leaving final approval to Kian or Radha here.

DrW3RK · 2023-06-30T13:29:24Z

This is very resourceful. Thank you, Bader! Let's merge this and share the readable Wiki doc to the relevant teams at Parity for feedback.

CrackTheCode016 · 2023-06-30T14:11:06Z

@filippoweb3 psst, needs your approval (changes were addressed!) :)

CrackTheCode016 added the A1 - In Progress Not ready for review yet. label May 17, 2023

CrackTheCode016 self-assigned this May 17, 2023

CrackTheCode016 mentioned this pull request May 21, 2023

*THE* Polkadot SDK Tutorial paritytech/polkadot-sdk-docs#3

Open

CrackTheCode016 requested review from DrW3RK and filippoweb3 May 25, 2023 18:29

filippoweb3 requested changes Jun 1, 2023

View reviewed changes

kianenigma reviewed Jun 1, 2023

View reviewed changes

CrackTheCode016 and others added 15 commits June 20, 2023 10:57

started development funnel

3a7fbaa

draft done

d3fee57

placeholder graph

8494a22

added pallet vs contract

37a6e47

update img

e3412c2

added tracks, moved stuff aroundzzz

5b2b358

added notion of STF in addition to runtime

2d6efe6

added client libs

130f3e8

temp tab fix + slight graphic fix

3f90c96

fixed tabs

831996f

added !

72f6cec

Update docs/build/build-guide.md

1bc3eb7

Co-authored-by: Filippo <110459737+filippoweb3@users.noreply.github.com>

Update docs/build/build-guide.md

f5bada8

Co-authored-by: Filippo <110459737+filippoweb3@users.noreply.github.com>

Update docs/build/build-guide.md

e7b9635

Co-authored-by: Filippo <110459737+filippoweb3@users.noreply.github.com>

Update docs/build/build-guide.md

d42a9a0

Co-authored-by: Filippo <110459737+filippoweb3@users.noreply.github.com>

Update docs/build/build-guide.md

6591ec7

Co-authored-by: Filippo <110459737+filippoweb3@users.noreply.github.com>

CrackTheCode016 force-pushed the polkadot-development branch from 824f392 to 6591ec7 Compare June 20, 2023 14:58

CrackTheCode016 mentioned this pull request Jun 21, 2023

Intro to Substrate MOOC (Tracking Issue) w3f/w3f-education#60

Closed

8 tasks

CrackTheCode016 added 4 commits June 22, 2023 10:21

working diagram

c15f953

minor stuff

3a5a930

grammar polish

bd2d91d

md tabled

2bab8c8

CrackTheCode016 requested a review from filippoweb3 June 22, 2023 15:23

styled diagram

38949a6

filippoweb3 reviewed Jun 23, 2023

View reviewed changes

CrackTheCode016 added A2 - Please Review Pull request is ready for review. and removed A1 - In Progress Not ready for review yet. labels Jun 23, 2023

DrW3RK approved these changes Jun 30, 2023

View reviewed changes

filippoweb3 approved these changes Jun 30, 2023

View reviewed changes

filippoweb3 merged commit ae6c09f into master Jun 30, 2023
3 checks passed

filippoweb3 deleted the polkadot-development branch June 30, 2023 14:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Draft] Polkadot Development Overview (build) #4810

[Draft] Polkadot Development Overview (build) #4810

CrackTheCode016 commented May 17, 2023 •

edited

Loading

kianenigma commented May 23, 2023

kianenigma commented May 23, 2023 •

edited

Loading

CrackTheCode016 commented May 24, 2023

CrackTheCode016 commented May 24, 2023 •

edited

Loading

filippoweb3 left a comment

filippoweb3 left a comment

kianenigma Jun 1, 2023

CrackTheCode016 Jun 2, 2023

kianenigma Jun 13, 2023

CrackTheCode016 Jun 15, 2023

CrackTheCode016 Jun 16, 2023

CrackTheCode016 Jun 22, 2023 •

edited

Loading

CrackTheCode016 Jun 22, 2023 •

edited

Loading

kianenigma Sep 11, 2023

kianenigma Jun 1, 2023

CrackTheCode016 Jun 2, 2023

kianenigma Jun 13, 2023

kianenigma Jun 1, 2023

CrackTheCode016 commented Jun 2, 2023

CrackTheCode016 commented Jun 22, 2023

filippoweb3 left a comment

DrW3RK commented Jun 30, 2023

CrackTheCode016 commented Jun 30, 2023


		## Development Ecosystem Overview

		![Path to Building a Parachain](../assets/parachain-development.png)

[Draft] Polkadot Development Overview (build) #4810

[Draft] Polkadot Development Overview (build) #4810

Conversation

CrackTheCode016 commented May 17, 2023 • edited Loading

kianenigma commented May 23, 2023

kianenigma commented May 23, 2023 • edited Loading

CrackTheCode016 commented May 24, 2023

CrackTheCode016 commented May 24, 2023 • edited Loading

filippoweb3 left a comment

Choose a reason for hiding this comment

filippoweb3 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CrackTheCode016 Jun 22, 2023 • edited Loading

Choose a reason for hiding this comment

CrackTheCode016 Jun 22, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CrackTheCode016 commented Jun 2, 2023

CrackTheCode016 commented Jun 22, 2023

filippoweb3 left a comment

Choose a reason for hiding this comment

DrW3RK commented Jun 30, 2023

CrackTheCode016 commented Jun 30, 2023

CrackTheCode016 commented May 17, 2023 •

edited

Loading

kianenigma commented May 23, 2023 •

edited

Loading

CrackTheCode016 commented May 24, 2023 •

edited

Loading

CrackTheCode016 Jun 22, 2023 •

edited

Loading

CrackTheCode016 Jun 22, 2023 •

edited

Loading