Skip to content

Book 2nd edition is broken on stable and beta #44704

Closed
@steveklabnik

Description

@steveklabnik

If this bug affects you, please see the workaround here: #44704 (comment)


The current stable and beta docs are missing a single javascript file, store.js.

Stable rust builds with mdbook=0.0.22 In 0.0.23, mdbook introduced a new javascript file, store.js. The Book second edition uses a custom template in order to display the "this is a draft" banner, and so, we updated it to include the new file rust-lang/book#783. However, this was wrong; it shouldn't have been done until mdbook was updated in the main repository. As such, things are now very broken:

book

As nightly has updated mdbook, this has been fixed, but having the main way of learning Rust broken for ~10 weeks isn't great.

For stable

We could fix the online docs by just uploading store.js to the appropriate place. I am normally very against changing what we distribute after the fact, but simply adding a file seems very minimal.

While this regression is in some sense very serious, I don't think it's worth cutting a new stable for, with this workaround.

For beta

In my opinion, we should send in a backport fix to beta. This involves upgrading mdbook on beta.


Tagging as "regression from stable to nightly" even though it's been fixed in nightly; this is about what to do for stable and beta. Tagging @rust-lang/infra for the stable fix, tagging @rust-lang/docs for the beta fix.

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-bugCategory: This is a bug.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions