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

Build Section Reorg - "Polkadot Developer Portal" #5332

Merged
merged 14 commits into from
Nov 15, 2023
Merged

Conversation

CrackTheCode016
Copy link
Contributor

@CrackTheCode016 CrackTheCode016 commented Nov 1, 2023

This PR aims to reorganize and breathe life into the builder's section of the Polkadot Wiki. It will separate and focus on three aspects of building on Polkadot:

  • Clientside/Frontend Development
  • Smart contracts (and their place within Polkadot)
  • Protocol development

To be clear, this is NOT development documentation, but moreso an overview of all tools to point a developer to the direction they want to go.

vision

When reviewing / reading this, I want you to think:

A developer who wants to tinker and get to know Polkadot, doesn't have a deep desire to learn web3, but is interested. They know about smart contracts, Ethereum, and what Solidity is (but perhaps have not used it). Unfortunately, friction, aka, not being able to easily see all options, can be a big deterrent to someone attempting to try developing on Polkadot.

This developer usually falls into one of three categories:

  1. "I want to develop an application on top of Polkadot and its parachains. How do I do that?"
  2. "I want to learn about creating blockchains (parachains or solo). How do I start?"
  3. "I want to deploy contracts on Polkadot. Can I? Why not? Where can I deploy contracts? Why would I use an EVM-based chain over actual EVM?"

As mentioned earlier, the job here is not to be developer documentation but to be a set of pointers to reliable resources.

problem with current structure (slightly opinionated)

Each page is far too long. For someone new, it can take a long time to, let's say, find a front-end library and start developing. In-depth information should exist, but tools vs.s information should be separate.

It should also avoid any 'salesy' talk about why Polkadot is the best solution (IMHO). It should offer technical details relevant to building, and why those are secure/fast/scalable, but not to the extent of trying to convince someone.

current / old

Screenshot 2023-11-02 at 9 44 52 AM

new / refractored (wip)

@CrackTheCode016 CrackTheCode016 added the A1 - In Progress Not ready for review yet. label Nov 1, 2023
@CrackTheCode016 CrackTheCode016 self-assigned this Nov 1, 2023
@CrackTheCode016 CrackTheCode016 changed the title Build Section Reorg Build Section Reorg - "Polkadot Developer Portal" Nov 2, 2023
@CrackTheCode016
Copy link
Contributor Author

For those who may review / context for those who are viewing this pr:

Adopting the DRY (don't repeat yourself) principle here is pretty important imo. For example, lets look at several sections here:

It is acceptable that these two exist, however these are now two explanations that need to be maintained! We should choose a master explanation for the high level, and link away a guide/spec for the build context.

This kind of repetitiveness could present confusion, but also unnecessary bloat to a page that makes it hard to digest and make useful conclusions from the content.

@CrackTheCode016
Copy link
Contributor Author

CrackTheCode016 commented Nov 6, 2023

Besides high level currency stuff, most of build-protocol-info can be deleted and instead point to the developer hub.

PS: this should be done for most content in order to keep the scope of the Wiki intact. Applications / usages of the tech is fine, exact details which may change later (ala, extrinsic encoding, runtime versioning/upgrades) should point elsewhere

@CrackTheCode016 CrackTheCode016 added A2 - Please Review Pull request is ready for review. and removed A1 - In Progress Not ready for review yet. labels Nov 14, 2023
Copy link
Contributor

@filippoweb3 filippoweb3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is awesome! :)

@filippoweb3 filippoweb3 merged commit d3aae50 into master Nov 15, 2023
2 checks passed
@filippoweb3 filippoweb3 deleted the build-reorg branch November 15, 2023 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A2 - Please Review Pull request is ready for review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants