rust-lang / rust-lang/docs.rs

Make nightly version configurable

Open
#228 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-builds C-enhancement E-medium
Dominant language
Rust
Stars
1.2k
Forks
232
Avg merge
11h 35m
Merged PRs (30d)
60

Description

It happens from time to time that some crate can't build on a nightly version which results in broken documentation. In this case the author of the crate usually has to wait for the nightly version docs.rs uses to be bumped and hope that problems will go away.

Right now, my crate barrel fails to build documentation because the diesel version I require requires a newer nightly.

It would be so much better if, apart from bumping the nightly version from time to time, enabling users to tell docs.rs what nightly version to use. This way users can either opt-into the current nightly or pin documentation on a version they know works.

Edit After having seen https://github.com/onur/docs.rs/pull/225 I'm wondering what other work is needed to make the rust version used by docs.rs configurable.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Start by reviewing how docs.rs selects its nightly Rust version and the configuration work discussed in PR #225. Done means users can select or pin a nightly version while the existing default remains available.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
build-system
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.