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

Differentiate the documentation pages for new users. #2135

Open
olafurw opened this issue May 31, 2023 · 0 comments
Open

Differentiate the documentation pages for new users. #2135

olafurw opened this issue May 31, 2023 · 0 comments
Labels
A-frontend Area: Web frontend A-newcomer-roadblock Area: A problem that isn't a bug, but makes it harder for people to contribute

Comments

@olafurw
Copy link

olafurw commented May 31, 2023

Hi, this is not a high priority issue but it's one I just want to have here.

When I was learning Rust for the first time, the documentation pages confused me, especially since the entry point for a lot of users is just googling "rust" + "some stuff" and see if documentation exists.

So Googling "rust rand" gives me this page https://docs.rs/rand/latest/rand/ which has the same look and feel as the official rust documentation page. https://doc.rust-lang.org/std/

Except for a slightly different logo and the top bar.

But for a new user that is going between pages, to them this is the same page. And then they need to learn that, no, rand is actually a library.

So, to help out new users. Can docs.rs or the official docs page do something visual to differentiate them from each other.

Color, layout, highlights, something obvious when you enter the page and scan around.

Something that tells you immediately "We're not in Kansas anymore."

<3

@syphar syphar added A-newcomer-roadblock Area: A problem that isn't a bug, but makes it harder for people to contribute A-frontend Area: Web frontend labels Aug 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-frontend Area: Web frontend A-newcomer-roadblock Area: A problem that isn't a bug, but makes it harder for people to contribute
Projects
None yet
Development

No branches or pull requests

2 participants