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

Do some cleanup of doc/index.md #107062

Merged
merged 1 commit into from
Feb 26, 2023
Merged

Conversation

tgross35
Copy link
Contributor

I think a lot of people get to this landing page from rustup doc, and it's a bit tricky to find some useful information. I attempted to clean it up here a bit, from the commit message:

  • Add quick link to API docs
  • Add marker for external links, to help offline users
  • Add information about using 'cargo doc' and the playground
  • Clean up some of the wording
  • Update body & header style to match rustdoc defaults
  • Bump heading levels so main page header is 1, others are 2 (all were level 1 before)

@rustbot
Copy link
Collaborator

rustbot commented Jan 19, 2023

r? @ehuss

(rustbot has picked a reviewer for you, use r? to override)

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jan 19, 2023
@tgross35
Copy link
Contributor Author

@rustbot label +A-docs

@rustbot rustbot added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Jan 19, 2023
Copy link
Contributor

@ehuss ehuss left a comment

Choose a reason for hiding this comment

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

Thanks, this looks good!

src/doc/index.md Outdated Show resolved Hide resolved
src/doc/index.md Outdated Show resolved Hide resolved
src/doc/index.md Outdated Show resolved Hide resolved
src/doc/index.md Outdated Show resolved Hide resolved
@tgross35
Copy link
Contributor Author

tgross35 commented Jan 19, 2023

Thanks for the review, I'll get through the comments

Edit: all set for another look when you have the chance

@tgross35
Copy link
Contributor Author

Ah sorry, this slipped my mind! I’ll fix this up this weekend

@tgross35 tgross35 force-pushed the update-doc-index branch 2 times, most recently from ac2281c to 64b15cf Compare February 24, 2023 05:46
- Add quick link to API docs
- Add marker for external links, to help offline users
- Add information about using 'cargo doc' and the playground
- Clean up some of the wording
- Update body & header style to match rustdoc defaults
@tgross35
Copy link
Contributor Author

Alright @ehuss I think this should be ready for a final look through when you get the chance 👍

@ehuss
Copy link
Contributor

ehuss commented Feb 25, 2023

Thanks!

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Feb 25, 2023

📌 Commit 4ecf143 has been approved by ehuss

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Feb 25, 2023
bors added a commit to rust-lang-ci/rust that referenced this pull request Feb 26, 2023
…iaskrgr

Rollup of 8 pull requests

Successful merges:

 - rust-lang#107062 (Do some cleanup of doc/index.md)
 - rust-lang#107890 (Lint against `Iterator::map` receiving a callable that returns `()`)
 - rust-lang#108431 (Add regression test for rust-lang#107918)
 - rust-lang#108432 (test: drop unused deps)
 - rust-lang#108436 (make "proc macro panicked" translatable)
 - rust-lang#108444 (docs/test: add UI test and docs for `E0476`)
 - rust-lang#108449 (Do not lint ineffective unstable trait impl for unresolved trait)
 - rust-lang#108456 (Complete migrating `ast_passes` to derive diagnostics)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit f840799 into rust-lang:master Feb 26, 2023
@rustbot rustbot added this to the 1.69.0 milestone Feb 26, 2023
@tgross35 tgross35 deleted the update-doc-index branch February 26, 2023 06:36
@tgross35
Copy link
Contributor Author

Thank you!

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 S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants