Better organize type/expression/items.

Open
#589 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Read the Reference pages for types, expressions, and items, using struct as the example, and compare how the same topic is explained across them. A finished contribution would have an agreed organizational approach, with the relevant sections combined or cross-linked consistently rather than leaving readers to find three disconnected pages.

Written by the indexing model from the issue text.

Description

C-discussion Organization

I find it somewhat confusing how many things are explained in 3 places: types, expressions, and items. A good example is "struct". There are 3 pages you have to read to learn about them. Sometimes the pages don't even link to one another.

I'm not sure what can be done. Combining them would be a major shift in organization. Just cross-linking them would be a good start, but I think would be insufficient overall.

(Note: I thought there was an issue on this already, but I can't find it now.)

Dominant language
Rust
Stars
1.6k
Forks
607
Avg merge
1d 1h
Merged PRs (30d)
12

Contributor guide

Open the contributing guide

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.

More from rust-lang/reference

All issues in rust-lang/reference

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.