-
Notifications
You must be signed in to change notification settings - Fork 2.3k
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
Conversation
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. |
Besides high level currency stuff, most of 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is awesome! :)
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:
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:
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
new / refractored (wip)