rust-lang / rust-lang/docs.rs

Hard to find documentation link

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

Nobody has claimed this yet.

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

Description

image

This is my second time having this issue, I was looking at the links in the menu but I can't find link to the documentation. It took me 5 minutes (I realized this is the second time having this issue) to figure out the button to documentation which is so far away.

image

My experience

Some more the button above wasn't the first point I pressed, I first try pressing
image

But I noticed that it goes to the same page. Then I try finding it in
image

But I can't seemed to see any related link. At last (when I almost give up),

image

🎉 I found it, took quite a lot of effort, I wonder if this was changed back then.

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

Review the screenshots and the current menu and navigation paths described in the issue. Decide where a documentation link should be surfaced so users can find it without searching multiple menus. Done means the documentation entry is clearly discoverable from the main navigation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, web-dev
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.