Skip to content

Update rustdoc.md to point to correct file. #144854

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

Closed
wants to merge 1 commit into from
Closed

Conversation

przb
Copy link

@przb przb commented Aug 3, 2025

Noticed the link was broken, Found what seemed like a reasonable file to point to instead.

@rustbot
Copy link
Collaborator

rustbot commented Aug 3, 2025

r? @GuillaumeGomez

rustbot has assigned @GuillaumeGomez.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Aug 3, 2025
@GuillaumeGomez
Copy link
Member

Thanks!

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Aug 3, 2025

📌 Commit e8108d3 has been approved by GuillaumeGomez

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 Aug 3, 2025
@rust-log-analyzer
Copy link
Collaborator

The job aarch64-gnu-llvm-19-2 failed! Check out the build log: (web) (plain enhanced) (plain)

Click to see the possible cause of the failure (guessed by this bot)
##[endgroup]
[TIMING] core::build_steps::tool::ToolBuild { build_compiler: Compiler { stage: 0, host: aarch64-unknown-linux-gnu, forced_compiler: false }, target: aarch64-unknown-linux-gnu, tool: "linkchecker", path: "src/tools/linkchecker", mode: ToolBootstrap, source_type: InTree, extra_features: [], allow_features: "", cargo_args: [], artifact_kind: Binary } -- 0.157
[TIMING] core::build_steps::tool::Linkchecker { compiler: Compiler { stage: 0, host: aarch64-unknown-linux-gnu, forced_compiler: false }, target: aarch64-unknown-linux-gnu } -- 0.000
##[group]Testing stage0 Linkcheck (aarch64-unknown-linux-gnu)
rustdoc.html:31: broken link - `rustdoc/src/SUMMARY.md`
checked links in: 22.7s
number of HTML files scanned: 46023
number of HTML redirects found: 14501
number of links checked: 2528157
number of links ignored due to external: 98344
number of links ignored due to exceptions: 24
number of intra doc links ignored: 9
errors found: 1
found some broken links
NOTE: if you are adding or renaming a markdown file in a mdBook, don't forget to register the page in SUMMARY.md
Command has failed. Rerun with -v to see more details.
Build completed unsuccessfully in 0:34:05
  local time: Sun Aug  3 15:39:17 UTC 2025
  network time: Sun, 03 Aug 2025 15:39:17 GMT
##[error]Process completed with exit code 1.
Post job cleanup.

@GuillaumeGomez
Copy link
Member

@bors r-

@bors bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Aug 3, 2025
@@ -1,3 +1,3 @@
% Rust Documentation

This has been moved [into the rustdoc book](rustdoc/index.html).
This has been moved [into the rustdoc book](rustdoc/src/SUMMARY.md).
Copy link
Contributor

Choose a reason for hiding this comment

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

I guess in the final output what you want is not a markdown file?

Copy link
Author

@przb przb Aug 3, 2025

Choose a reason for hiding this comment

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

Could you maybe clarify what your question? The previous link to rustdoc/index.html does not exist anymore. I was perusing the codebase and it sent me to a 404 page. It seemed to me like it should link to the rustdoc src directory, so I updated the link.

@slanterns
Copy link
Contributor

slanterns commented Aug 3, 2025

Actually the link is not broken, it just doesn't work on Github md preview (but works fine on the website.) Other pages also include similar links e.g. https://github.com/rust-lang/rust/blob/master/src/doc/guide-unsafe.md. Changing it to pointing to a md file will result in an invalid link on the website.

@przb
Copy link
Author

przb commented Aug 4, 2025

Good catch @slanterns. Closing this PR then

@przb przb closed this Aug 4, 2025
@rustbot rustbot removed the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Aug 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants