Skip to content

Improve stability of rustdoc #50023

Closed
Closed
@Diggsey

Description

@Diggsey

Recently there have been a lot of issues introduced with rustdoc.

Reported issues:

Additional issues:

  • Docs are now incredibly slow to load
  • Search bar is bugged (cannot type 's' into the search bar!)
  • Anchor links broken to collapsed sections
  • Search showing duplicate results
  • Some items are shown in search results that don't exist on the page it links to

It makes me really sad that the documentation is now so much worse to use than it used to be.

If this is because development of rustdoc can't keep up with changes to the compiler internals, then there's not really anything that can be done here, but from an outside perspective it seems like many of these issues stem from new features being added to rustdoc, many of which have... questionable value, and are not sufficiently tested.

The problem is made worse because https://docs.rs/ uses the nightly compiler to build its documentation. I don't want to see this change because a lot of crates are nightly-only, or have nightly-specific features that it is important to document, but the net result is that the canonical documentation for many rust crates is now almost unusable, especially on slow internet connections.

Metadata

Metadata

Assignees

No one assigned

    Labels

    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