From 70d81fd61b218f57c63315f5a1a1d93002cee2f5 Mon Sep 17 00:00:00 2001 From: kianenigma Date: Fri, 31 Jan 2025 12:57:15 +0000 Subject: [PATCH 1/3] update a few substrate related links --- README.md | 2 ++ docs/contributor/DEPRECATION_CHECKLIST.md | 4 ++-- docs/mermaid/IA.mmd | 2 +- docs/sdk/src/external_resources.rs | 4 ++-- docs/sdk/src/lib.rs | 3 +-- docs/sdk/src/meta_contributing.rs | 6 ------ substrate/frame/alliance/Cargo.toml | 2 +- 7 files changed, 9 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 24352cc28a1a..2016d936c213 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,9 @@ curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/paritytec ## 📚 Documentation +* [Polkadot Documentation Portal](https://docs.polkadot.com) * [🦀 rust-docs](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/index.html) + * Where we keep track of the API docs of our Rust crates. Includes: * [Introduction](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/index.html) to each component of the Polkadot SDK: Substrate, FRAME, Cumulus, and XCM * [Guides](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/guides/index.html), diff --git a/docs/contributor/DEPRECATION_CHECKLIST.md b/docs/contributor/DEPRECATION_CHECKLIST.md index 687c0a7cd7da..1ffd2b4dae64 100644 --- a/docs/contributor/DEPRECATION_CHECKLIST.md +++ b/docs/contributor/DEPRECATION_CHECKLIST.md @@ -38,8 +38,8 @@ when building the code. ## Update examples and tutorials Make sure that the rust docs are updated. -We also need [https://docs.substrate.io/](https://docs.substrate.io/) to be updated accordingly. The repo behind it is -[https://github.com/substrate-developer-hub/substrate-docs](https://github.com/substrate-developer-hub/substrate-docs). +We also need [https://docs.polkadot.com/](https://docs.polkadot.com/) to be updated accordingly. The repo behind it is +[https://github.com/polkadot-developers/polkadot-docs](https://github.com/polkadot-developers/polkadot-docs). ## Announce the deprecation and removal diff --git a/docs/mermaid/IA.mmd b/docs/mermaid/IA.mmd index dcf9806dcb62..60a59f6e0ab9 100644 --- a/docs/mermaid/IA.mmd +++ b/docs/mermaid/IA.mmd @@ -1,5 +1,5 @@ flowchart - parity[paritytech.github.io] --> devhub[polkadot_sdk_docs] + dot[docs.polkadot.com] --> devhub[polkadot_sdk_docs] devhub --> polkadot_sdk devhub --> reference_docs diff --git a/docs/sdk/src/external_resources.rs b/docs/sdk/src/external_resources.rs index 939874d12f13..dc68ad25badf 100644 --- a/docs/sdk/src/external_resources.rs +++ b/docs/sdk/src/external_resources.rs @@ -9,6 +9,6 @@ //! //! - [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 Developers Github Organization](https://github.com/polkadot-developers/) //! - [Polkadot Blockchain Academy](https://github.com/Polkadot-Blockchain-Academy) -//! - [Polkadot Wiki: Build](https://wiki.polkadot.network/docs/build-guide) +//! - [Polkadot Wiki](https://wiki.polkadot.network/) diff --git a/docs/sdk/src/lib.rs b/docs/sdk/src/lib.rs index e2c5fc93479c..2fff72c9d171 100644 --- a/docs/sdk/src/lib.rs +++ b/docs/sdk/src/lib.rs @@ -2,8 +2,7 @@ //! //! The Polkadot SDK Developer Documentation. //! -//! This crate is a *minimal*, but *always-accurate* source of information for those wishing to -//! build on the Polkadot SDK. +//! This crate is a *minimal*, *always-accurate* and low level source of truth about Polkadot-SDK. For more high level docs, please go to [docs.polkadot.com](https://docs.polkadot.com). //! //! ## Getting Started //! diff --git a/docs/sdk/src/meta_contributing.rs b/docs/sdk/src/meta_contributing.rs index d68d9bca18b1..663da2cc54b3 100644 --- a/docs/sdk/src/meta_contributing.rs +++ b/docs/sdk/src/meta_contributing.rs @@ -120,12 +120,6 @@ //! //! //! -//! ## `docs.substrate.io` -//! -//! This crate is meant to gradually replace `docs.substrate.io`. As any content is added here, the -//! corresponding counter-part should be marked as deprecated, as described -//! [here](https://github.com/paritytech/polkadot-sdk-docs/issues/26). -//! //! ## `crates.io` and Publishing //! //! As it stands now, this crate cannot be published to crates.io because of its use of diff --git a/substrate/frame/alliance/Cargo.toml b/substrate/frame/alliance/Cargo.toml index 9d21b9e964c9..99eb8ba3a864 100644 --- a/substrate/frame/alliance/Cargo.toml +++ b/substrate/frame/alliance/Cargo.toml @@ -4,7 +4,7 @@ version = "27.0.0" authors.workspace = true edition.workspace = true license = "Apache-2.0" -homepage = "https://docs.substrate.io/" +homepage.workspace = true repository.workspace = true description = "The Alliance pallet provides a collective for standard-setting industry collaboration." readme = "README.md" From 976ea2f5cd8d0ece80a182949ceecca2ec15b709 Mon Sep 17 00:00:00 2001 From: kianenigma Date: Fri, 31 Jan 2025 12:58:02 +0000 Subject: [PATCH 2/3] fmt --- docs/sdk/src/lib.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/sdk/src/lib.rs b/docs/sdk/src/lib.rs index 2fff72c9d171..d96239ca8942 100644 --- a/docs/sdk/src/lib.rs +++ b/docs/sdk/src/lib.rs @@ -2,7 +2,8 @@ //! //! The Polkadot SDK Developer Documentation. //! -//! This crate is a *minimal*, *always-accurate* and low level source of truth about Polkadot-SDK. For more high level docs, please go to [docs.polkadot.com](https://docs.polkadot.com). +//! This crate is a *minimal*, *always-accurate* and low level source of truth about Polkadot-SDK. +//! For more high level docs, please go to [docs.polkadot.com](https://docs.polkadot.com). //! //! ## Getting Started //! From abc841fc305b5b9077b17fd30c8a639021cf53ab Mon Sep 17 00:00:00 2001 From: Kian Paimani <5588131+kianenigma@users.noreply.github.com> Date: Tue, 4 Feb 2025 12:17:59 +0000 Subject: [PATCH 3/3] Update README.md Co-authored-by: Guillaume Thiolliere --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 2016d936c213..2aed93455da6 100644 --- a/README.md +++ b/README.md @@ -27,8 +27,7 @@ curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/paritytec ## 📚 Documentation * [Polkadot Documentation Portal](https://docs.polkadot.com) -* [🦀 rust-docs](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/index.html) - * Where we keep track of the API docs of our Rust crates. Includes: +* [🦀 rust-docs](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/index.html): Where we keep track of the API docs of our Rust crates. Includes: * [Introduction](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/index.html) to each component of the Polkadot SDK: Substrate, FRAME, Cumulus, and XCM * [Guides](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/guides/index.html),