Skip to content

fix(docs): include registry instructions in docs, even for substrate as a git dep #731

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

Merged
rohanku merged 2 commits into from
Jun 7, 2026
Merged

fix(docs): include registry instructions in docs, even for substrate as a git dep #731

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
f7e869c
fix(docs): include registry instructions in docs, even for substrate …
rohanku Jun 7, 2026
7a844de
remove use of Docusaurus code block attributes in README.md
rohanku Jun 7, 2026
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
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,14 @@ 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 (`~/.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
[dependencies]
Expand Down
5 changes: 1 addition & 4 deletions docs/docusaurus/versioned_docs/version-release/getting-started/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}}") ? <div>
First, add the Substrate registry to your Cargo config:
Then, add the Substrate registry to your Cargo config:

<SubstrateRegistryConfig/>

You only need to do this the first time you set up Substrate.

</div> : <div/> }

Next, create a new Rust project:

```bash
Expand Down
Loading