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.

Sign up for GitHub

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

Jump to bottom

include more external links and resources #5758

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+25 −9
Open

include more external links and resources #5758

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99bcbd9
include more external links and resources in
kianenigma Sep 18, 2024
46bc08b
Merge branch 'master' into kiz-some-sdk-docs
bkchr Oct 16, 2024
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ forks](https://img.shields.io/github/forks/paritytech/polkadot-sdk)

## ⚡ Quickstart
If you want to get an example node running quickly you can execute the following getting started script:

```
curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/paritytech/polkadot-sdk/master/scripts/getting-started.sh | bash
```
Expand All @@ -31,9 +32,8 @@ curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/paritytec
* [Guides](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/guides/index.html),
namely how to build your first FRAME pallet
* [Templates](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/templates/index.html)
for starting a new project
* Other resources:
* [Polkadot Wiki -> Build](https://wiki.polkadot.network/docs/build-guide)
for starting a new project.
* [External Resources](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/external_resources/index.html)

## 🚀 Releases

Expand Down
4 changes: 2 additions & 2 deletions docs/mermaid/IA.mmd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
flowchart
parity[paritytech.github.io] --> devhub[polkadot_sdk_docs]
polkadot_network[polkadot.network] --> devhub[polkadot_sdk_docs]

devhub --> polkadot_sdk
devhub --> reference_docs
devhub --> guides
devhub --> external_resources

polkadot_sdk --> substrate
polkadot_sdk --> frame
polkadot_sdk --> cumulus
polkadot_sdk --> polkadot[polkadot node]
polkadot_sdk --> xcm
polkadot_sdk --> templates
14 changes: 14 additions & 0 deletions docs/sdk/src/external_resources.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
//! # External Resources
//!
//! A non-exhaustive, un-opinionated list of external resources about Polkadot SDK.
//!
//! Unlike [`crate::guides`], or [`crate::polkadot_sdk::templates`] that contain material directly
//! maintained in the `polkadot-sdk` repository, the list of resources here are maintained by
//! third-parties, and are therefore subject to more variability. Any further resources may be added
//! by opening a pull request to the `polkadot-sdk` repository.
//!
//! - [Polkadot NFT Tutorial by Polkadot Fellow Shawn Tabrizi](https://www.shawntabrizi.com/substrate-collectables-workshop/0/index.html)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
//! - [Polkadot NFT Tutorial by Polkadot Fellow Shawn Tabrizi](https://www.shawntabrizi.com/substrate-collectables-workshop/0/index.html)
//! - [Polkadot NFT Marketplace Tutorial by Polkadot Fellow Shawn Tabrizi](https://www.shawntabrizi.com/substrate-collectables-workshop/)

//! - [DOT Code School](https://dotcodeschool.com/)
//! - [Polkadot Developers](https://github.com/polkadot-developers/)
//! - [Polkadot Blockchain Academy](https://github.com/Polkadot-Blockchain-Academy)
//! - [Polkadot Wiki: Build](https://wiki.polkadot.network/docs/build-guide)
7 changes: 4 additions & 3 deletions docs/sdk/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@
//! This crate is a *minimal*, but *always-accurate* source of information for those wishing to
//! build on the Polkadot SDK.
//!
//! > **Work in Progress**: This crate is under heavy development. Expect content to be moved and
//! > changed. Do not use links to this crate yet. See [`meta_contributing`] for more information.
//!
//! ## Getting Started
//!
//! We suggest the following reading sequence:
Expand Down Expand Up @@ -35,9 +32,13 @@
/// how one can contribute to it.
pub mod meta_contributing;

/// A list of external resources and learning material about Polkadot SDK.
pub mod external_resources;

/// In-depth guides about the most common components of the Polkadot SDK. They are slightly more
/// high level and broad than [`reference_docs`].
pub mod guides;

/// An introduction to the Polkadot SDK. Read this module to learn about the structure of the SDK,
/// the tools that are provided as a part of it, and to gain a high level understanding of each.
pub mod polkadot_sdk;
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk/src/polkadot_sdk/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,10 @@
//! A list of projects and tools in the blockchain ecosystem that one way or another use parts of
//! the Polkadot SDK:
//!
//! * [Polygon's spin-off, Avail](https://github.com/availproject/avail)
//! * [Avail](https://github.com/availproject/avail)
//! * [Cardano Partner Chains](https://iohk.io/en/blog/posts/2023/11/03/partner-chains-are-coming-to-cardano/)
//! * [Starknet's Madara Sequencer](https://github.com/keep-starknet-strange/madara)
//! * [Polymesh](https://polymesh.network/)
//!
//! [`substrate`]: crate::polkadot_sdk::substrate
//! [`frame`]: crate::polkadot_sdk::frame_runtime
Expand Down
Loading