From f7e869c81f6fe87131077b9cd953a0d76f274205 Mon Sep 17 00:00:00 2001 From: Rohan Kumar Date: Sat, 6 Jun 2026 19:27:45 -0700 Subject: [PATCH 1/2] fix(docs): include registry instructions in docs, even for substrate as a git dep --- README.md | 12 +++++++++--- .../version-release/getting-started/quickstart.md | 5 +---- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5bf1a74c1..e67574887 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,16 @@ User documentation, including installation instructions, tutorials, and API docu ## Installation/Usage -To use Substrate, [install Rust](https://www.rust-lang.org/tools/install), -and add `substrate` as a dependency in your project's Cargo.toml: +To use Substrate, [install Rust](https://www.rust-lang.org/tools/install) and add the Substrate registry to your Cargo config: -```toml +```toml title="~/.cargo/config.toml" +[registries] +substrate = { index = "https://github.com/substrate-labs/crates-index" } +``` + +Then, add `substrate` as a dependency in your project's Cargo.toml: + +```toml title="Cargo.toml" [dependencies] substrate = { git = "https://github.com/substrate-labs/substrate2", branch = "main" } ``` diff --git a/docs/docusaurus/versioned_docs/version-release/getting-started/quickstart.md b/docs/docusaurus/versioned_docs/version-release/getting-started/quickstart.md index 5f42e04b7..38fd0a85f 100644 --- a/docs/docusaurus/versioned_docs/version-release/getting-started/quickstart.md +++ b/docs/docusaurus/versioned_docs/version-release/getting-started/quickstart.md @@ -23,15 +23,12 @@ Ensure that you have version 1.80.0 or beyond. Also ensure that you have the [protocol buffer compiler](https://grpc.io/docs/protoc-installation/) (`protoc`) installed. -{ isRelease("{{VERSION}}") ?
-First, add the Substrate registry to your Cargo config: +Then, add the Substrate registry to your Cargo config: You only need to do this the first time you set up Substrate. -
:
} - Next, create a new Rust project: ```bash From 7a844deb816845f3803d0f3b25711be90885d44e Mon Sep 17 00:00:00 2001 From: Rohan Kumar Date: Sat, 6 Jun 2026 19:29:38 -0700 Subject: [PATCH 2/2] remove use of Docusaurus code block attributes in README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e67574887..4a7d870f1 100644 --- a/README.md +++ b/README.md @@ -11,16 +11,16 @@ User documentation, including installation instructions, tutorials, and API docu ## Installation/Usage -To use Substrate, [install Rust](https://www.rust-lang.org/tools/install) and add the Substrate registry to your Cargo config: +To use Substrate, [install Rust](https://www.rust-lang.org/tools/install) and add the Substrate registry to your Cargo config (`~/.cargo/config.toml`): -```toml title="~/.cargo/config.toml" +```toml [registries] substrate = { index = "https://github.com/substrate-labs/crates-index" } ``` Then, add `substrate` as a dependency in your project's Cargo.toml: -```toml title="Cargo.toml" +```toml [dependencies] substrate = { git = "https://github.com/substrate-labs/substrate2", branch = "main" } ```