Skip to content
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

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

Closed
tirr-c opened this issue Jun 11, 2017 · 3 comments
Closed

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

tirr-c opened this issue Jun 11, 2017 · 3 comments
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools

Comments

@tirr-c
Copy link
Contributor

tirr-c commented Jun 11, 2017

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?

@steveklabnik steveklabnik added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Jun 12, 2017
@steveklabnik
Copy link
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
Copy link
Contributor Author

tirr-c commented Jun 12, 2017

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
Copy link
Member

steveklabnik commented Jun 12, 2017

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 :)

bors added a commit that referenced this issue Jun 15, 2017
Update older URLs pointing to the first edition of the Book

Fixes #42589.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools
Projects
None yet
Development

No branches or pull requests

2 participants