[docs] Fix broken links

[DiegoAndai]

Fix broken links reported in https://app.circleci.com/pipelines/github/mui/base-ui/2800/workflows/addeece5-c28e-48b7-9f29-fb49d9bf1327/jobs/17721.

All of these are from core to core, so the link check broke. It would be good to fix this check in this same PR.

[DiegoAndai]

I'm curious why the check reports links on https://mui.com/ domain, as most of these changes are on next only, and as far as I can tell they haven't leaked into master.

[mui-bot]

Netlify deploy preview

• docs/data/material/customization/creating-themed-components/creating-themed-components.md
• docs/data/material/migration/migration-grid-v2/migration-grid-v2.md
• docs/data/material/migration/migration-v4/v5-component-changes.md
• docs/data/system/styled/styled.md

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against 02e2b2c

[alexfauquette]

I'm curious why the check reports links on https://mui.com/ domain, as most of these changes are on next only, and as far as I can tell they haven't leaked into master.

Because it does not really look at https://mui.com it's just a sugar syntax in the report such that you can easily copy past the URL to see the page in your browser:

material-ui/docs/scripts/reportBrokenLinks.js

Lines 213 to 217 in bacd2db

	.forEach((linkKey) => {
	write(`- https://mui.com${linkKey}`);
	console.log(`https://mui.com${linkKey}`);
	console.log(`used in`);
	usedLinks[linkKey].forEach((f) => console.log(`- ${path.relative(docsSpaceRoot, f)}`));

The true testing is about relative links

material-ui/docs/scripts/reportBrokenLinks.js

Line 205 in bacd2db

.filter((link) => link.startsWith('/'))

[mnajdova]

Because it does not really look at https://mui.com it's just a sugar syntax in the report such that you can easily copy past the URL to see the page in your browser:

It looks like a good candidate to use the <!-- #default-branch-switch --> comment, we can switch it when changing the default branch.

[michaldudak]

These changes look OK, but IMO it would be better to fix the link-check script first (to ensure it catches them)

[alexfauquette]

The fix is here #43195

The script was completely broken due to what I assume is a breaking change in the marked package. The scrip was unable to extract links from pages.

@michaldudak Do you know if it's feasible to add test on scripts? None of the docs scripts are tested. I don't know what to do to add one such that this does not happened again

[michaldudak]

The cleanest way I can think of would be to extract the script logic into packages-internal/scripts, test it there and leave just the CLI in the scripts directory.

[DiegoAndai]

Hey @alexfauquette, sorry for the delay on this PR. I updated it, and it's ready for review again.

[alexfauquette]

As long as the section anchor exist, I'm happy with it ;)

[oliviertassinari]

Interesting tradeoff. A blog post like v5 isn't read much in the future, the page view distribution overtime is very much an exp(2-2x), so we shouldn't have to maintain those links 👍