Skip to content

linkchecker: add a reminder on broken links to add new/renamed pages to SUMMARY.md for mdBooks#131737

Merged
bors merged 1 commit into
rust-lang:masterfrom
jieyouxu:note-summary
Oct 21, 2024
Merged

linkchecker: add a reminder on broken links to add new/renamed pages to SUMMARY.md for mdBooks#131737
bors merged 1 commit into
rust-lang:masterfrom
jieyouxu:note-summary

Conversation

@jieyouxu

Copy link
Copy Markdown
Member

I spent an embarrassingly long amount of time trying to figure out why CI was failing for a PR adding new platform support docs. In turns out it's because the PR author didn't register the new page in SUMMARY.md. I completely forgot about it too, and was reading linkchecker source because I thought it was a bug in linkchecker.

So this PR adds a note to modify SUMMARY.md when adding new pages in a mdBook.

E.g.

# Adding a new `meow` target but forgor to register the page in `SUMMARY.md`
rustc\platform-support.html:183: broken link - `rustc\platform-support\meow.html`
rustc\print.html:9730: broken link - `rustc\platform-support\meow.html`
checked links in: 19.1s
number of HTML files scanned: 43588
number of HTML redirects found: 13735
number of links checked: 3145951
number of links ignored due to external: 156244
number of links ignored due to exceptions: 9
number of intra doc links ignored: 8
errors found: 2
NOTE: if you are adding or renaming a markdown file in a mdBook, don't forget to register the page in SUMMARY.md
found some broken links

@rustbot

rustbot commented Oct 15, 2024

Copy link
Copy Markdown
Collaborator

r? @ehuss

rustbot has assigned @ehuss.
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 the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 15, 2024
@ehuss

ehuss commented Oct 21, 2024

Copy link
Copy Markdown
Contributor

Thanks!

@bors r+ rollup

@bors

bors commented Oct 21, 2024

Copy link
Copy Markdown
Collaborator

📌 Commit 5f74fde 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 Oct 21, 2024
@bors
bors merged commit 1cc8c8d into rust-lang:master Oct 21, 2024
@rustbot rustbot added this to the 1.84.0 milestone Oct 21, 2024
@jieyouxu
jieyouxu deleted the note-summary branch October 22, 2024 02:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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.

4 participants