Skip to content
This repository has been archived by the owner on Aug 20, 2020. It is now read-only.

Migrate rustdocs links #14

Open
JoshOrndorff opened this issue Apr 16, 2020 · 1 comment
Open

Migrate rustdocs links #14

JoshOrndorff opened this issue Apr 16, 2020 · 1 comment

Comments

@JoshOrndorff
Copy link
Contributor

Now that our crates are published on crates.io, our docs are also published on docs.rs.

We should replace all substrate.dev/rustdocs links with the corresponding docs.rs links. For example https://docs.rs/sc-service/ (which points to latest published version) or https://docs.rs/sc-service/0.8.0-alpha.3/sc_service/ which points to a specific version.

context: paritytech/substrate#5652

@danforbes
Copy link
Contributor

Noting that we have some team-internal discussion about the best platform for the Substrate Rustdoc. We should leave this issue open to track the proper migration of all Rustdocs, but we may not want to use docs.rs in particular because it does not allow searching across (Substrate) crates.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants