Skip to content

Commit

Permalink
update readme to link to the new polkadot-docs (paritytech#7411)
Browse files Browse the repository at this point in the history
closes polkadot-developers/polkadot-docs#238

---------

Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com>
  • Loading branch information
kianenigma and gui1117 authored Feb 10, 2025
1 parent f96da6f commit bd1b02f
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 15 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/paritytec

## 📚 Documentation

* [🦀 rust-docs](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/index.html)
* [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),
Expand Down
4 changes: 2 additions & 2 deletions docs/contributor/DEPRECATION_CHECKLIST.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/mermaid/IA.mmd
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/src/external_resources.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
4 changes: 2 additions & 2 deletions docs/sdk/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
//!
//! 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
//!
Expand Down
6 changes: 0 additions & 6 deletions docs/sdk/src/meta_contributing.rs
Original file line number Diff line number Diff line change
Expand Up @@ -120,12 +120,6 @@
//!
//! </details>
//!
//! ## `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
Expand Down
2 changes: 1 addition & 1 deletion substrate/frame/alliance/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit bd1b02f

Please sign in to comment.