rust-lang / rust-lang/docs.rs

Crate's docs.rs page irritatingly empty

Open
#2,019 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Only after much irritation, I understood that using #![cfg(target_os = "windows")] is responsible for my crates https://docs.rs/win-beep/latest/win_beep/ and https://docs.rs/vcvars/latest/vcvars/ showing empty documentation. How must it be for a potential user of the crates?

I read that using #![cfg(target_os = "windows")] is better than causing compiler errors in a crate dependency (the crate being the dependency of others).

I now know that I can show the documentation by choosing an entry from the "Platform" drop-down menu (the entries are quite cryptic though, easily scaring you off). But I think docs.rs should, e.g., automatically choose a non empty "Platform" entry to be displayed.

Maybe it would be best to choose a platform that corresponds to what can be retrieved from the running browser (favoring 64 bits, of course, if this info can't be retrieved). And if that would result in an empty crate, show a message, if true, that there are other non-empty crate variants behind the "Platform" drop-down menu.

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

Start by opening the linked docs.rs pages and using the Platform drop-down to reproduce the empty default view and the available non-empty variants. Read the issue's proposed browser-based platform selection and fallback message requirements; done means an appropriate non-empty platform is selected when possible, with clear guidance when another variant must be chosen.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation, web-dev
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.