You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
rustup doc is very useful, but has a lot of edge cases. if you don't have rust-docs installed or the documentation is not packaged through static.rust-lang.org, you won't be able to read it. this requires people to download more, but more importantly, it greatly limits the number of places rustup can link (a few examples off the top of my head that are necessarily missing: crates.io, docs.rs, play.rust-lang.org, the security policy).
Solution you'd like
it would be great if rustup had a mode for opening online docs as well. my suggestion is something like this:
for existing docs, fallback to the online version if they're not installed locally (rustup already knows the channel names from the toolchain names so this should be fairly simple). if desired, rustup could have an --offline flag to disable this behavior.
for online-only docs, open the page directly (and give a hard error if --offline is passed)
for a list of links i think should be added, https://rust.tf/ is a good start - some of those are biased towards contributors, not users, but a lot of them are useful to both.
Notes
No response
The text was updated successfully, but these errors were encountered:
What problem is this solving? That is what is the advantage of rustup linking you to crates.io vs googling it? Sorry if this sounds like I'm missing the point .. I probably am :)
Note that the assumption I'm starting from here is that rustup is only concerned with the language level docs - docs for crates, dependencies, etc are better handled by cargo doc or other cargo-aware tooling.
What problem is this solving? That is what is the advantage of rustup linking you to crates.io vs googling it? Sorry if this sounds like I'm missing the point .. I probably am :)
Note that the assumption I'm starting from here is that rustup is only concerned with the language level docs
i would also consider docs.rs and crates.io to be part of the toolchain, even though they're concerned with crates, because they're official projects of the rust organization. i feel similarly about the security policy.
in general the advantage of rustup doc is that you know it's an official rust project by the fact that rustup supports it. googling crates.io doesn't give you that certainty.
Problem you are trying to solve
rustup doc
is very useful, but has a lot of edge cases. if you don't haverust-docs
installed or the documentation is not packaged through static.rust-lang.org, you won't be able to read it. this requires people to download more, but more importantly, it greatly limits the number of places rustup can link (a few examples off the top of my head that are necessarily missing: crates.io, docs.rs, play.rust-lang.org, the security policy).Solution you'd like
it would be great if rustup had a mode for opening online docs as well. my suggestion is something like this:
for existing docs, fallback to the online version if they're not installed locally (rustup already knows the channel names from the toolchain names so this should be fairly simple). if desired, rustup could have an
--offline
flag to disable this behavior.for online-only docs, open the page directly (and give a hard error if
--offline
is passed)for a list of links i think should be added, https://rust.tf/ is a good start - some of those are biased towards contributors, not users, but a lot of them are useful to both.
Notes
No response
The text was updated successfully, but these errors were encountered: