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

update readme to link to the new polkadot-docs #7411

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

update readme to link to the new polkadot-docs #7411

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
70d81fd
update a few substrate related links
kianenigma Jan 31, 2025
976ea2f
fmt
kianenigma Jan 31, 2025
abc841f
Update README.md
kianenigma Feb 4, 2025
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
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
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

* [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:
kianenigma marked this conversation as resolved.
Show resolved Hide resolved
* [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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
Loading