Skip to content

Provides rustc related crates that not in crates.io #79

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

Open
liigo opened this issue Nov 3, 2016 · 14 comments
Open

Provides rustc related crates that not in crates.io #79

liigo opened this issue Nov 3, 2016 · 14 comments
Labels
E-easy Effort: Should be easy to implement and would make a good first PR mentor This has instructions for getting started

Comments

@liigo
Copy link

liigo commented Nov 3, 2016

Docs of HIR, MIR, etc. are useful for some developers.

@jyn514
Copy link
Member

jyn514 commented Feb 1, 2020

@liigo we have links to the standard library and a few other resource under the 'Rust' dropdown in the navigation panel. If you have any specific links you would like, feel free to open a new issue (or make a PR adding them yourself, mentoring instructions here: #137 (comment))

@jyn514 jyn514 closed this as completed Feb 1, 2020
@liigo
Copy link
Author

liigo commented Feb 5, 2020

@jyn514 there's no rustc related api docs listed in the 'Rust' dropdown currently, so i don't think this issue is resolved.

@jyn514
Copy link
Member

jyn514 commented Feb 5, 2020

Ah sorry I misread rustc as rust.

@jyn514 jyn514 reopened this Feb 5, 2020
@jyn514
Copy link
Member

jyn514 commented Feb 5, 2020

Mentoring instructions:

@jyn514 jyn514 added E-easy Effort: Should be easy to implement and would make a good first PR mentor This has instructions for getting started labels Feb 5, 2020
@liigo
Copy link
Author

liigo commented Feb 5, 2020

Thank you!

@jyn514
Copy link
Member

jyn514 commented Feb 5, 2020

Also, @pietroalbini are you comfortable adding links to rustc specifically? I know it's currently the only Rust implementation, but mrustc is a thing and I'm not sure if others are planned (in the far future) ...

@pietroalbini
Copy link
Member

The link I think @liigo mentions is https://doc.rust-lang.org/nightly/nightly-rustc/rustc/.

I don't think adding the link itself is worth though: it's only needed for people working on the compiler, and it's shown on the home page of the contributor guide.

liigo added a commit to liigo/docs.rs that referenced this issue Feb 5, 2020
@jyn514
Copy link
Member

jyn514 commented Feb 5, 2020

Maybe it would be helpful to link to the contributor guide instead?

@pietroalbini
Copy link
Member

Hmm, I still don't see much value in that, as a rustc contributor should already know that.

@jyn514
Copy link
Member

jyn514 commented Feb 5, 2020

Hmm, I still don't see much value in that, as a rustc contributor should already know that.

Speaking personally, I've made a couple PRs to rustc and I didn't know the contributor guide existed until recently. I don't think it hurts to advertise it a bit more.

@liigo
Copy link
Author

liigo commented Feb 11, 2020

Hmm, I still don't see much value in that, as a rustc contributor should already know that.

IMO if docs.rs is the home of all crates api docs, users would expect to find std and rustc api docs at the site. And they should be provided in the same way as other crates, not just in an external links list (the ‘Rust’ dropdown menu).

@jyn514
Copy link
Member

jyn514 commented Feb 11, 2020

docs.rs is the home of all crates api docs

But std and rustc are not crates, they are part of the compiler. Hosting std docs is significantly more difficult and expensive than hosting crates.io crates and we do not plan to support it anytime soon.

@jyn514
Copy link
Member

jyn514 commented Feb 11, 2020

BTW, you can go to https://docs.rs/std and it will redirect you to https://doc.rust-lang.org/stable/std/, which might be part of what you're looking for.

@jyn514
Copy link
Member

jyn514 commented Feb 11, 2020

Actually, maybe it would make sense to redirect rustc to https://doc.rust-lang.org/nightly/nightly-rustc/rustc/ as well? Not sure if rustc is a reserved name on crates.io.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
E-easy Effort: Should be easy to implement and would make a good first PR mentor This has instructions for getting started
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants