Skip to content

rustdoc should link to its current version of the rustdoc book #131971

Description

@lolbinarycat

currently, rustdoc just links to https://doc.rust-lang.org/rustdoc/

this could lead to confusion for old crates on docs.rs when someone tries to use a new feature and it doesn't work.

perhaps, rustdoc 1.80.1 should link to https://doc.rust-lang.org/1.80.1/rustdoc/ and other versions should link to their matching documentation...

Activity

  1. added
    T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
    on Oct 20, 2024
  2. added
    needs-triageThis issue may need triage. Remove when done. See docs forge.rust-lang.org/release/issue-triaging
    on Oct 20, 2024
  3. removed
    needs-triageThis issue may need triage. Remove when done. See docs forge.rust-lang.org/release/issue-triaging
    on Nov 9, 2024
  4. added
    C-enhancementCategory: An issue proposing an enhancement or a PR with one.
    A-rustdoc-uiArea: Rustdoc UI (generated HTML)
    on Dec 6, 2024
  5. fmease commented on Dec 6, 2024

    @fmease
    Member

    rustdoc just links to […]

    I assume you're referring to the first paragraph of the help dropdown?

    You can find more information in the rustdoc book.

  6. lolbinarycat commented on Dec 7, 2024

    @lolbinarycat
    ContributorAuthor

    yes

  7. poliorcetics commented on Dec 26, 2024

    @poliorcetics
    Contributor

    Wasn't it already done a while ago: 2f1939a ?

    EDIT: It was only partially done, it hasn't been updated everywhere

  8. poliorcetics commented on Dec 26, 2024

    @poliorcetics
    Contributor

    @rustbot claim

  9. camelid commented on Feb 3, 2025

    @camelid
    Member

    The linked PR somewhat addresses this, though because docs.rs uses nightly rustdoc, all the doc.rust-lang.org links will be /nightly/... rather than a specific version. However, there's not really anything more we can do from the linking side of things because nightly versions are (of course) unstable and not finalized and thus aren't posted under their version number on doc.rust-lang.org. I don't think this is a particularly big issue though, so it seems reasonable to me to consider this resolved with the PR.

  10. added 2 commits that reference this issue on Feb 3, 2025
    e25f9fc
    dcc1acf
  11. added a commit that references this issue on Feb 3, 2025
    8ba9efd
  12. added 2 commits that reference this issue on Feb 3, 2025
    50a5c59
    f8f31fa
  13. added a commit that references this issue on Feb 4, 2025
    fe08a88
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

A-rustdoc-uiArea: Rustdoc UI (generated HTML)C-enhancementCategory: An issue proposing an enhancement or a PR with one.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions