rust-lang / rust-lang/docs.rs

Tracking Issue for Packages as (optional) namespaces

Open
#2,457 1 comment 1 reaction 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

RFC: #3243

Allow a parent package to open its API namespace for other packages to participate


main points to be discussed / designed:

  • allow :: in crate names, nothing should break
  • allow navigation in the namespace (for example as a dropdown in the topbar, and/or as a section in the sidebar)
  • perhaps build namespace crates together to be able to search them together, similar to when dependencies are built with rustdoc default

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 reading RFC #3243 and compare its proposal with the rustc, Cargo, and crates.io tracking issues linked in the description. Review the namespace navigation and combined-build/search ideas, then determine the agreed scope and acceptance criteria before identifying implementation entry points in docs.rs.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.