Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The standard libary documentation renders some links as red, they feel like missing pages to me #47801

Closed
timClicks opened this issue Jan 27, 2018 · 9 comments
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@timClicks
Copy link
Contributor

In the interests of improving the on-boarding experience for newcomers to Rust, I thought it would be worthwhile to share a personal anecdote of something that was a snag for my own learning.

Apparently I've been trained by Wikipedia/MediaWiki defaults to see red links and think they mean missing page. It took me an embarrassingly long time to realize that struct definitions are perfectly clickable. So for several months while learning Rust I eagerly waited for Rust's docs to be updated with info about their struct definitions.

I have no idea if this is a widespread phenomenon, but remarkably the cognitive dissonance still lingers. I'm also not certain if this warrants filing an issue. Feel free to mark as wontfix :)

@pietroalbini pietroalbini added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-dev-tools-rustdoc C-enhancement Category: An issue proposing an enhancement or a PR with one. labels Jan 27, 2018
@nagisa
Copy link
Member

nagisa commented Jan 27, 2018

We certainly can change the colour to something else.

@nagisa nagisa added the E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. label Jan 27, 2018
@nagisa
Copy link
Member

nagisa commented Jan 27, 2018

Fixing this would involve changing this class (and the equivalent for the dark theme css) to some other colour.

@PramodBisht
Copy link
Contributor

PramodBisht commented Jan 27, 2018

@nagisa I would like to take that up. Any suggestion what color I should use for both themes?

@nagisa
Copy link
Member

nagisa commented Jan 27, 2018

I’ve no opinions on the colour, other than that it should be distinct enough from the colours used for the other kinds of items.

@tinaun
Copy link
Contributor

tinaun commented Jan 27, 2018

the color has always looked orange to me, perhaps make it slightly lighter?

@kennytm kennytm added A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools and removed T-dev-tools-rustdoc labels Jan 27, 2018
@kennytm
Copy link
Member

kennytm commented Jan 27, 2018

Changing the team from dev-tools/rustdoc to docs. This is more about a stylistic decision of the documentation.

@phansch
Copy link
Member

phansch commented Jan 28, 2018

fwiw, I picked up Rust ~2 months ago and initially had the same thought when reading Rust documentation with lots of red links

kennytm added a commit to kennytm/rust that referenced this issue Feb 14, 2018
…labnik

Changed color of struct link from #ff794d to #2dbfb8 for Rust docs

This is in reference to rust-lang#47801

here I have changed the default color of struct link for `#ff794d` to `#2dbfb8`

cc: @nagisa  @timClicks
@pickfire
Copy link
Contributor

That orange does look nice to me though. But the more confusing parts to me is that some clickable parts are black (it takes me some time to figure out how to go to other crates doc or previous level of crates doc without pressing the previous tab button in browser).

As reference: https://doc.rust-lang.org/std/ops/struct.Range.html

  • std and ops from the title (std::ops::Range) are clickable.
  • std::ops in rectangle from the left navigation bar are clickable, not congruent with Struct Range in rectangle above it.

@steveklabnik
Copy link
Member

I believe this was fixed by #47806

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests