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

Short doc url don't mention Rust version at all #14466

Closed
huonw opened this issue May 27, 2014 · 12 comments
Closed

Short doc url don't mention Rust version at all #14466

huonw opened this issue May 27, 2014 · 12 comments
Labels
C-feature-request Category: A feature request, i.e: not implemented / a PR. P-low Low priority T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@huonw
Copy link
Member

huonw commented May 27, 2014

E.g. http://doc.rust-lang.org/std/index.html

Possible solutions:

  • not have the short forms
  • have the version on each page
  • redirect to the .../master/... or .../1.0/... (or whatever) version as appropriate
@alexcrichton
Copy link
Member

The current action is intentional, and we have some rules in nginx to rewrite urls to /master. I personally like the short urls, but it's true that there's no indication in the url or on the page what the version is.

Nominating, we should probably have stable doc urls for 1.0.

@taralx
Copy link
Contributor

taralx commented May 28, 2014

What about displaying the version number on the page, with a dropdown to change it, like Python has?

@brson brson added P-low and removed I-nominated labels May 29, 2014
@brson brson added this to the 1.0 milestone May 29, 2014
@brson
Copy link
Contributor

brson commented May 29, 2014

1.0 P-low

@brson
Copy link
Contributor

brson commented Aug 1, 2014

One of Google's SEO recommendation is "Provide one version of a URL to
reach a document" (from here), which might argue for redirects instead.

@taralx
Copy link
Contributor

taralx commented Aug 1, 2014

link rel="canonical" fixes that.

@brson
Copy link
Contributor

brson commented Sep 11, 2014

Nominating for removal from 1.0. Not critical.

@pnkfelix
Copy link
Member

Leaving as P-low, removing from 1.0 milestone list. No one wants to block the release on this issue.

@mdinger
Copy link
Contributor

mdinger commented Feb 8, 2015

I like how python labels versions at the top left and allows you to switch between them:

python_docs


Ruby also makes it prominent modifying their image:

ruby_docs

@steveklabnik steveklabnik added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. and removed A-docs labels Feb 16, 2015
@brson brson removed their assignment Mar 12, 2015
@steveklabnik
Copy link
Member

#22168 is another problem that comes out of this thing.

I'm wondering if we shouldn't just axe the short URLs alltogether, or always re-write them to nightly.

@steveklabnik
Copy link
Member

Triage: no change.

@steveklabnik steveklabnik added T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. and removed T-tools labels May 18, 2017
@Mark-Simulacrum Mark-Simulacrum added the C-feature-request Category: A feature request, i.e: not implemented / a PR. label Jul 21, 2017
@QuietMisdreavus
Copy link
Member

Discussion related to this happened in and around RFC 1826, so something to alleviate this is probably going to happen eventually.

@Mark-Simulacrum
Copy link
Member

I'm going to close this as what we should do here is not for this issue -- and I believe the tracking issue for the 1826 RFC lays this out in better detail: #44687

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-feature-request Category: A feature request, i.e: not implemented / a PR. P-low Low priority T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

9 participants