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

[docs] Basic link verification at PR level #34588

Merged
merged 9 commits into from
Oct 14, 2022

Conversation

alexfauquette
Copy link
Member

@alexfauquette alexfauquette commented Oct 3, 2022

Add automatic verification for internal links inside this repository.

During static tests, it runs yarn docs:link-check which will generate a report about unfound links in the file docs/broken-links.txt

If the file get changed by the PR, the test will fail. Then you have two solutions:

  • You've broken a link then you can fix it
  • It's a false positive. Just run yarn docs:link-check and add the updated broken-links.txt to your PR

I created a dedicated draft PR to show how the test fails when you modify the title of a section but not link anchors referring to it
PR (and the failing test)

That could help @samuelsycamore when renaming sections

@mui-bot
Copy link

mui-bot commented Oct 3, 2022

No bundle size changes

Generated by 🚫 dangerJS against f8e4ce0

@alexfauquette alexfauquette added the docs Improvements or additions to the documentation label Oct 10, 2022
@alexfauquette alexfauquette marked this pull request as ready for review October 10, 2022 11:11
@alexfauquette alexfauquette changed the title [docs] fix links [docs] Basic link verification at PR level Oct 10, 2022
Copy link
Member

@oliviertassinari oliviertassinari left a comment

Choose a reason for hiding this comment

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

Nice! It seems that we found the issues before ahrefs :) https://app.ahrefs.com/site-audit/3524616/33/overview

docs/scripts/reportBrokenLinks.js Outdated Show resolved Hide resolved
docs/scripts/reportBrokenLinks.js Outdated Show resolved Hide resolved
docs/scripts/reportBrokenLinks.js Outdated Show resolved Hide resolved
docs/scripts/reportBrokenLinks.js Outdated Show resolved Hide resolved
@alexfauquette alexfauquette added the website Pages that are not documentation-related, marketing-focused. label Oct 14, 2022
@alexfauquette alexfauquette merged commit 9cf9de6 into mui:master Oct 14, 2022
@alexfauquette alexfauquette deleted the fix-links branch October 14, 2022 16:09
daniel-rabe pushed a commit to daniel-rabe/material-ui that referenced this pull request Nov 29, 2022
feliperli pushed a commit to jesrodri/material-ui that referenced this pull request Dec 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation website Pages that are not documentation-related, marketing-focused.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants