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

Re-write the doc index page #39593

Merged
merged 2 commits into from
Feb 8, 2017
Merged

Conversation

steveklabnik
Copy link
Member

Clarify and reorganize.

Add the section for the bookshelf. More to come here in the near future!

Part of #39588

Clarify and reorganize.

Add the section for the bookshelf. More to come here in the near future!

Part of rust-lang#39588
@rust-highfive
Copy link
Collaborator

@steveklabnik: no appropriate reviewer found, use r? to override

@steveklabnik
Copy link
Member Author

r? @rust-lang/docs

@QuietMisdreavus
Copy link
Member

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]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docs.rs?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@onur, how should we refer to your project here?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this supposed to be "come with error codes"?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, thanks!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't true though, there are errors which don't have error codes like error: main function not found.

@steveklabnik
Copy link
Member Author

@QuietMisdreavus good call, and it's not great SEO either.

@camlorn , do you have opinions here?

@ahicks92
Copy link
Contributor

ahicks92 commented Feb 7, 2017

@steveklabnik
This is a tough one. For me, it's fine. I'm not sure how common using tab actually is, but I don't and consequently get them in context.

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.

@steveklabnik
Copy link
Member Author

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.

@steveklabnik
Copy link
Member Author

Review concerns should be addressed.

@frewsxcv
Copy link
Member

frewsxcv commented Feb 7, 2017

Looks great! @bors r+ rollup

@bors
Copy link
Contributor

bors commented Feb 7, 2017

📌 Commit 78dd2ec has been approved by frewsxcv

frewsxcv added a commit to frewsxcv/rust that referenced this pull request Feb 8, 2017
…, 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
frewsxcv added a commit to frewsxcv/rust that referenced this pull request Feb 8, 2017
…, 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
bors added a commit that referenced this pull request Feb 8, 2017
Rollup of 13 pull requests

- Successful merges: #38764, #39361, #39372, #39374, #39400, #39426, #39431, #39459, #39482, #39545, #39593, #39620, #39621
- Failed merges:
@bors bors merged commit 78dd2ec into rust-lang:master Feb 8, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants