-
Notifications
You must be signed in to change notification settings - Fork 12.9k
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.
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
Don't put docs for rustc/syntax/etc on doc.rust-lang.org #21297
Comments
It should be |
|
Possibly a separate issue, but where libraries exist both in Would it be clearer if these things were handled by |
@cmr but there are a significant number of users of Rust who will just use Why not |
@mrec always on the external one, and I don't think submodules are appropriate, as 1) they suck (:wink:) and 2) more seriously, they can diverge. some of them already have, a bit. |
@steveklabnik Then they should be part of some "unstable", "internal", or some other page for these crates. I don't see a benefit to having the easily accessible from the front page, and this isn't the first time it has caused confusion. |
If we hide rustc's documentation, that means we can remove it from the distribution as well right? Rustc docs alone account for a whopping 150MB of the installation from a nightly, roughly 50% of the docs.
|
@bluss I'd hope so, yes. Ideally librustc etc would not be in |
More generally, we need to be able to hide |
@aturon Shouldn't be too difficult to add a |
It would be good if these and all other unstable APIs where still hosted somewhere, even if the stable channel docs didn't include them. |
I presume that the stable docs will be hosted somewhere like http://doc.rust-lang.org/stable/, with beta and nightly releases hosted at appropriately different URLs. |
Can put these on nightly, but leave off of beta and stable. |
polish issue, 1.0 (but not 1.0 beta). |
Thank you Cmr! |
Would it be possible to keep the compiler internals docs somewhere? I find them pretty useful for writing plugins and such, and I don't want to bootstrap rustc just for the docs. |
I'm spending half the morning searching for the syntax crate docs to see how the ast changed so I can fix tojson_macros, and I can't find them presumably due to this issue. I'm all for not confusing new users, but the docs ought to exist somewhere. These are currently not found under http://doc.rust-lang.org/nightly , but IMHO should be. For now I'm reading the source code. |
@mikedilger we have a different issue tracking this, they will end up being hosted. However, in the meantime: http://manishearth.github.io/rust-internals-docs/ |
People are getting confused about why these libraries are there. The only crate that should be documented and linked from the homepage is
std
.The text was updated successfully, but these errors were encountered: