rust-lang / rust-lang/docs.rs

WIP template on docs.rs for new crates in the queue

Open
#2,762 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-frontend E-easy P-low
Dominant language
Rust
Stars
1.2k
Forks
232
Avg merge
11h 35m
Merged PRs (30d)
60

Description

When one publishes a new crate, it could take some time before docs.rs is able to build its docs for the first time and during that time, docs.rs/crate-name just says "no such crate". It would be great if it instead showed a template page that says that crate docs are currently in the build queue and will be available shortly.

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

No files or tests are named. Start by tracing how docs.rs handles requests for crates that have not built yet, then inspect how build-queue state is represented. Done means a newly published crate in the queue shows a waiting template instead of “no such crate,” while unavailable crates still receive the appropriate response.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.