rust-lang / rust-lang/docs.rs

Unify crate details handling across all pages

Open
#1,138 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Mostly to fix #1093, but more specific issue for the refactoring I think should solve it.

The metadata used for rendering builds and source files doesn't currently pull enough details from the database for this, I think it might make the most sense to make both of them get the full CrateDetails and move the is_latest_version etc. checking into Tera helpers rather than being extra context variables, removing the separate MetaData struct at the same time.

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 locating the metadata paths that render builds and source files, then read the definitions and uses of CrateDetails and MetaData. Compare the handling described in issue #1093 and trace the existing is_latest_version checks. Done means both paths use full CrateDetails, those checks are handled by Tera helpers, and the separate MetaData struct is removed.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.