Skip to content

Some links in the API documentation point to the older URL of the Book #42589

Closed
@tirr-c

Description

@tirr-c
Contributor

The first edition of the Book is moved from /book into /book/first-edition, but some links in the API documentation are not following the change. For example, in core::ops::Deref documentation, there is a link to the 'Deref coercions' page of the first edition, with older URL structure.

This makes kind of "broken link" in the documentation, though it's not a real broken link, because the pages under the older URL suggest that we try with the namespace added. However, it does add additional link that visitors should follow, which probably isn't what they want.

I think the solution is simple; adding first-edition namespace if the link pointing to the Book does not have any namespace. May I work on this issue?

Activity

added
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and tools
on Jun 12, 2017
steveklabnik

steveklabnik commented on Jun 12, 2017

@steveklabnik
Member

I think the solution is simple; adding first-edition namespace if the link pointing to the Book does not have any namespace. May I work on this issue?

yes, this is a great initial fix! A slightly better one would be to update them to the appropriate spot in the second edition, but that's going to be harder.

tirr-c

tirr-c commented on Jun 12, 2017

@tirr-c
ContributorAuthor

I noticed that not all documents are moved into first-edition; some documents are moved into the Unstable Book. Fixing the broken links would be harder than I thought...


Only compiler-plugins.html is moved into the Unstable Book. I hope simple exception handling will do the thing.

steveklabnik

steveklabnik commented on Jun 12, 2017

@steveklabnik
Member

Yeah, that should be the only real thing. I'd imagine.

It is also super okay to submit a PR for just some of this as well, if anything is hard to find, feel free to skip it, or post a PR and ask about the ones you're not sure, and I'll happily lend a hand :)

added a commit that references this issue on Jun 15, 2017

Auto merge of #42623 - VBChunguk:fix-older-urls, r=steveklabnik

16c27bf
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

    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and tools

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @steveklabnik@tirr-c

        Issue actions

          Some links in the API documentation point to the older URL of the Book · Issue #42589 · rust-lang/rust