Re-write the doc index page #39593
Re-write the doc index page #39593
Conversation
Clarify and reorganize. Add the section for the bookshelf. More to come here in the near future! Part of rust-lang#39588
|
@steveklabnik: no appropriate reviewer found, use r? to override |
|
r? @rust-lang/docs |
|
Nit: If I remember right, making the link text for all those links simple the word "here" doesn't work well with screen readers, because if you're jumping from link to link, all you hear is the word "here" repeatedly. |
| website](https://www.rust-lang.org). | ||
| This page is an overview of the documentation included with your Rust install. | ||
| Other unofficial documentation may exist elsewhere; for example, the [Rust | ||
| Learning] project collects documentation from the community, and [Docs.rs] |
There was a problem hiding this comment.
@onur, how should we refer to your project here?
There was a problem hiding this comment.
@steveklabnik I think this referral is enough, but it's up to you.
src/doc/index.md
Outdated
| nicknamed 'The Rust Bookshelf.' | ||
|
|
||
| * [The Rust Programming Language][book] teaches you how to program in Rust. | ||
| * [The Rustinomicon][nomicon] is your guidebook to the dark arts of unsafe Rust. |
There was a problem hiding this comment.
typo Rustinomicon -> Rustonomicon
src/doc/index.md
Outdated
|
|
||
| [book]: book/index.html | ||
| [ref]: reference.html | ||
| All of Rust's errors code with error codes, and you can request extended |
There was a problem hiding this comment.
Is this supposed to be "come with error codes"?
There was a problem hiding this comment.
This isn't true though, there are errors which don't have error codes like error: main function not found.
|
@QuietMisdreavus good call, and it's not great SEO either. @camlorn , do you have opinions here? |
|
@steveklabnik I wouldn't notice, basically. But the thing is that you're asking an extreme power user this question, and honestly I have no idea. It's probably best to change them, but I'd never have thought to open an issue or PR actually changing them after the fact. take that for what it's worth. Sorry I can't be more helpful here. |
It's all good! Even this response is helpful here. |
|
Review concerns should be addressed. |
|
Looks great! @bors r+ rollup |
|
📌 Commit 78dd2ec has been approved by |
…, r=frewsxcv Re-write the doc index page Clarify and reorganize. Add the section for the bookshelf. More to come here in the near future! Part of rust-lang#39588
…, r=frewsxcv Re-write the doc index page Clarify and reorganize. Add the section for the bookshelf. More to come here in the near future! Part of rust-lang#39588
Clarify and reorganize.
Add the section for the bookshelf. More to come here in the near future!
Part of #39588