Skip to content

rename to rustc-dev-guide #470

Closed
Closed
@nikomatsakis

Description

@nikomatsakis
Contributor

I propose we rename this repo to the rustc-dev-guide, to avoid confusion with the "rustc book" (and maybe we ought to rename that to the "rustc user's manual" or something, but that's a separate topic).

cc @rust-lang/compiler @rust-lang/wg-learning

Activity

spastorino

spastorino commented on Oct 17, 2019

@spastorino
Member

👍, I was confused also by the book and the guide existence too. Actually, I'd rename both things and the names you proposed seem great.

JohnTitor

JohnTitor commented on Oct 17, 2019

@JohnTitor
Member

+1 from me, the renaming seems reasonable.

mark-i-m

mark-i-m commented on Oct 17, 2019

@mark-i-m
Member

Alas, users strike again. I've always felt computer science would be way more fun if we had no users...

nikomatsakis

nikomatsakis commented on Oct 17, 2019

@nikomatsakis
ContributorAuthor

Does anyone know -- if I rename the repo, will links to the rendered format also redirect?

eddyb

eddyb commented on Oct 17, 2019

@eddyb
Member

All github.com links will redirect but github.io ones won't.

mark-i-m

mark-i-m commented on Oct 17, 2019

@mark-i-m
Member

Yes, github will redirect the links.

We should fix the following links in the guide itself, though:

$ rg github.io/rustc-guide
README.md
6:[You can read the latest version of the guide here.](https://rust-lang.github.io/rustc-guide/)

src/important-links.md
14:[link](https://rust-lang.github.io/rustc-guide/stabilization_guide.html)
15:[link](https://rust-lang.github.io/rustc-guide/stabilization_guide.html#updating-documentation)
16:[link](https://rust-lang.github.io/rustc-guide/stabilization_guide.html#documentation-prs)

src/implementing_new_features.md
181:[here]: https://rust-lang.github.io/rustc-guide/stabilization_guide.html

src/tests/running.md
126:[mode]: https://rust-lang.github.io/rustc-guide/tests/adding.html#tests-that-do-not-result-in-compile-errors

Additionally, we will probably have broken links in the rust-lang/rust and rust-lang/forge repos in some readmes, I think...

michaelwoerister

michaelwoerister commented on Oct 21, 2019

@michaelwoerister
Member

👍 for renaming.

mark-i-m

mark-i-m commented on Nov 14, 2019

@mark-i-m
Member

I'm generally against renaming, as I think it will cause a lot of headaches. IMHO, those in favor of renaming should find the links that are going to break and make a list so that we can fix them.

mark-i-m

mark-i-m commented on Dec 22, 2019

@mark-i-m
Member

@tshepang Perhaps we make the old address redirect to the new one or add a link like "are you looking for the rustc-dev-guide? Click here"

mark-i-m

mark-i-m commented on Dec 22, 2019

@mark-i-m
Member

And we should maybe make a blog post

tshepang

tshepang commented on Dec 22, 2019

@tshepang
Member

@mark-i-m if that's all the links we care for, won't we get redirects for free, then fix such links at our leisure?

mark-i-m

mark-i-m commented on Dec 22, 2019

@mark-i-m
Member

@tshepang No I don't think so. TMK, Github only redirects links under github.com, not GitHub pages. That's why the forge has a manual list of redirects...

pnkfelix

pnkfelix commented on Dec 22, 2019

@pnkfelix
Member

If we are trying to address subtle differences in names, maybe we should spell out “rust compiler dev guide” rather than rely on the single letter “c” for the distinction between “Rust development” and “rustc development”?

24 remaining items

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @spastorino@eddyb@nikomatsakis@pnkfelix@RalfJung

        Issue actions

          rename to rustc-dev-guide · Issue #470 · rust-lang/rustc-dev-guide