Skip to content
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
59 commits
Select commit Hold shift + click to select a range
a451f7e
add developer-hub and all things related
kianenigma Oct 31, 2023
68a053b
fix some things
kianenigma Oct 31, 2023
f7460d8
small fixes
kianenigma Oct 31, 2023
b785e5c
Create docs.yml
kianenigma Oct 31, 2023
00a0fec
Update docs.yml
kianenigma Oct 31, 2023
50c78b4
fix some warnings
kianenigma Oct 31, 2023
89e00e9
Merge branch 'kiz-developer-hub' of github.com:kianenigma/polkadot-sd…
kianenigma Oct 31, 2023
c91250b
fix some warnings
kianenigma Oct 31, 2023
6d57d2e
fix warns
kianenigma Oct 31, 2023
76f2277
update
kianenigma Nov 1, 2023
08802f8
fix
kianenigma Nov 2, 2023
2ec4541
publish note
kianenigma Nov 2, 2023
a826834
fix
kianenigma Nov 2, 2023
8e2f6b8
Master.into()
kianenigma Nov 2, 2023
df2d645
Merge branch 'master' of github.com:paritytech/polkadot-sdk into kiz-…
liamaharon Nov 3, 2023
58d60cb
fix build
liamaharon Nov 3, 2023
c8f7f1e
default page developer hub
liamaharon Nov 3, 2023
198a3e6
Master.into()
kianenigma Nov 4, 2023
bcdc9d5
add lot of ref docs
kianenigma Nov 4, 2023
4664874
Merge branch 'kiz-developer-hub' of github.com:paritytech/polkadot-sd…
kianenigma Nov 4, 2023
d542ff1
Update substrate/frame/support/procedural/src/pallet/parse/call.rs
kianenigma Nov 4, 2023
2f76ba1
Update developer-hub/src/lib.rs
kianenigma Nov 4, 2023
00ec677
Update developer-hub/src/lib.rs
kianenigma Nov 4, 2023
9b1db8c
Update docs/mermaid/polkadot_sdk.mmd
kianenigma Nov 4, 2023
7dba4f8
Update developer-hub/src/polkadot_sdk/mod.rs
kianenigma Nov 4, 2023
3519a03
Update developer-hub/src/reference_docs/wasm_meta_protocol.rs
kianenigma Nov 4, 2023
0d72dd7
Apply suggestions from code review
kianenigma Nov 4, 2023
9942120
Apply suggestions from code review
kianenigma Nov 4, 2023
60a37a1
Upstream.into()
kianenigma Nov 4, 2023
1896ac7
reword templates page.
kianenigma Nov 4, 2023
30d6ac2
repot homepage
kianenigma Nov 4, 2023
a56d3b1
rework substrate dev section
kianenigma Nov 4, 2023
641ff3a
fix cumulus links
kianenigma Nov 4, 2023
3baa30c
Apply extrinsic-encoding ref doc suggestions
jsdw Nov 7, 2023
9c2b3ea
Apply singed-extensions ref doc suggestion
jsdw Nov 7, 2023
62b69fc
add about build
kianenigma Nov 9, 2023
4c8939b
most of the stuff done in polkadot_sdk mod
kianenigma Nov 9, 2023
7b225e1
Apply suggestions from code review
kianenigma Nov 9, 2023
0f55b9a
Update developer-hub/src/polkadot_sdk/cumulus.rs
kianenigma Nov 9, 2023
d08ab24
Update developer-hub/src/polkadot_sdk/cumulus.rs
kianenigma Nov 9, 2023
b9ee9c1
ready to merge
kianenigma Nov 9, 2023
a873808
merge about half a million comments and conflicts
kianenigma Nov 9, 2023
2d5814b
Master.into()
kianenigma Nov 9, 2023
94eeed6
deprecate tutorial
kianenigma Nov 9, 2023
80d4e9e
add missing glossary
juangirini Nov 10, 2023
24ba435
add pvf to the glossary
juangirini Nov 14, 2023
745c7fd
refactor tutorial to guides
juangirini Nov 14, 2023
d305146
fix fmt
juangirini Nov 14, 2023
1d1e4a0
Merge branch 'master' into kiz-developer-hub
juangirini Nov 14, 2023
74eb750
resolve import conflict
juangirini Nov 14, 2023
36baa71
fix ci
juangirini Nov 14, 2023
8defde9
fix ui tests
juangirini Nov 14, 2023
7c839fe
fix ui test
juangirini Nov 14, 2023
196d1d7
remove unused imports
juangirini Nov 15, 2023
f3b1b5b
Merge branch 'master' into kiz-developer-hub
juangirini Nov 15, 2023
0428686
Merge branch 'kiz-developer-hub' into jg/developer-hub-glossary-ref-docs
juangirini Nov 15, 2023
0235ee4
improve glossary
juangirini Nov 15, 2023
239c3a6
add suggested modifications
juangirini Nov 24, 2023
58fb40f
improve Validators definition
juangirini Nov 27, 2023
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
Prev Previous commit
Next Next commit
rework substrate dev section
  • Loading branch information
kianenigma committed Nov 4, 2023
commit a56d3b110df3e39a0ccaba2db4e5be87bf542a87
14 changes: 13 additions & 1 deletion developer-hub/src/polkadot_sdk/frame_runtime.rs
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@
//! The following examples showcases a minimal pallet.
#![doc = docify::embed!("src/polkadot_sdk/frame_runtime.rs", pallet)]
//!
//! ## Runtime
//!
//! A runtime is a collection of pallets that are amalgamated together. Each pallet typically has
//! some configurations (exposed as a `trait Config`) that needs to be *specified* in the runtime.
Expand All @@ -71,6 +70,19 @@
//! ## More Examples
//!
//! You can find more FRAME examples that revolve around specific features at [`pallet_examples`].
//!
//! ## Alternatives 🌈
//!
//! There is nothing in the Substrate's client side code-base that mandates the use of FRAME. While
//! FRAME makes it very simple to write Substrate-based runtimes, it is by no means intended to be
//! the only one. At the end of the day, any WASM blob that exposes the right set of runtime APIs is
//! a valid Runtime form the point of view of a Substrate cliemt (see
//! [`crate::reference_docs::wasm_meta_protocol`]). Notable examples are:
//!
//! * writing a runtime in pure Rust, as done in [this
//! template](https://github.com/JoshOrndorff/frameless-node-template).
//! * writing a runtime in AssemblyScript,as explored in [this
//! project](https://github.com/LimeChain/subsembly).

#[cfg(test)]
mod tests {
Expand Down
7 changes: 7 additions & 0 deletions developer-hub/src/polkadot_sdk/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,13 @@
//! - [`trie`](https://github.com/paritytech/trie)
//! - [`parity-common`](https://github.com/paritytech/parity-common)
//!
//! ## Trophy Section: Notable Downstream Projects
//!
//! A list of projects and tools in the blockchain ecosystem that one way or another parts of the Polkadot SDK.:
//!
//! * [Polygon's spin-off, Avail](https://github.com/availproject/avail)
//! * [Cardano Partner Chains](https://iohk.io/en/blog/posts/2023/11/03/partner-chains-are-coming-to-cardano/)
//!
//! [`substrate`]: crate::polkadot_sdk::substrate
//! [`frame`]: crate::polkadot_sdk::frame_runtime
//! [`cumulus`]: crate::polkadot_sdk::cumulus
Expand Down
4 changes: 4 additions & 0 deletions developer-hub/src/polkadot_sdk/polkadot.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@
//! - [The Polkadot Parachain Host Implementers' Guide](https://paritytech.github.io/polkadot-sdk/book/)
//! - [Whitepaper](https://www.polkadot.network/whitepaper/)
//!
//! ## Alternative Clients 🌈
//!
//! TODO:
//!
//! ## Platform
//!
//! ### Polkadot 1.x
Expand Down
25 changes: 13 additions & 12 deletions developer-hub/src/polkadot_sdk/substrate.rs
Original file line number Diff line number Diff line change
Expand Up @@ -39,19 +39,20 @@
//!
//! ## How to Get Stared
//!
//! While most developers use [`crate::polkadot_sdk::frame_runtime`], it is worth noting a
//! few (niche) alternatives:
//! Substrate offers different options at the spectrum of technical freedom <-> development ease.
//!
//! 1. It is entirely possible to craft a substrate-based runtime without FRAME, an example of which
//! can be found [here](https://github.com/JoshOrndorff/frameless-node-template).
//! 2. Substrate's client side code, as mentioned above, is also highly configurable, and many teams
//! embark on customizing the client, for example with a custom consensus algorithm. Notable
//! examples of this are:
//! * The easiest way to use Substrate is to use tap into one of the templates (some o which listed
//! at [`crate::polkadot_sdk::templates`]) and only tweak the parameters of the runtime or client.
//! This allows you to launch a blockchain in minutes, but is limited in technical freedom.
//! * Next, most developers wish to develop their custom runtime modules, for which the de-facto way
//! is [`frame`](crate::polkadot_sdk::frame_runtime).
//! * Finally, Substrate is fully highly configurable at the client side as well, but this is the
//! most technically demanding.
//!
//! - <https://github.com/Cardinal-Cryptography/aleph-node>
//! - <https://github.com/availproject/avail>
//! > A notable Substrate-based blockchain that has built both custom FRAME pallets and custom
//! > client-side components is <https://github.com/Cardinal-Cryptography/aleph-node>.
//!
//! 3. A number of Substrate-based templates are listed in [`crate::polkadot_sdk::templates`].
#![doc = simple_mermaid::mermaid!("../../../docs/mermaid/substrate_dev.mmd")]
//!
//! ## Structure
//!
Expand Down Expand Up @@ -128,8 +129,8 @@
//! through which Polkadot can be utilized is by building "parachains", blockchains that are
//! connected to Polkadot's shared security.
//!
//! To build a parachain, one could use [`crate::polkadot_sdk::cumulus`], the library on top
//! of Substrate, empowering any substrate-based chain to be a Polkadot parachain.
//! To build a parachain, one could use [`crate::polkadot_sdk::cumulus`], the library on top of
//! Substrate, empowering any substrate-based chain to be a Polkadot parachain.
//!
//! ## Where To Go Next?
//!
Expand Down
4 changes: 2 additions & 2 deletions docs/mermaid/polkadot_sdk_parachain.mmd
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ flowchart LR
FRAME -.-> ParachainRuntime
Substrate[Substrate Client Libraries] -.-> ParachainClient

Cumulus[Cumulus Client Libraries] -.-> ParachainClient
Cumulus[Cumulus Runtime Libraries] -.-> ParachainRuntime
CumulusC[Cumulus Client Libraries] -.-> ParachainClient
CumulusR[Cumulus Runtime Libraries] -.-> ParachainRuntime
2 changes: 2 additions & 0 deletions docs/mermaid/substrate_dev.mmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
flowchart LR
T[Using a Template] --> P[Writing Your Own FRAME-Based Pallet] --> C[Custom Client]