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

[core] Fix docs link check #12135

Merged
merged 5 commits into from
Feb 19, 2024
Merged

[core] Fix docs link check #12135

merged 5 commits into from
Feb 19, 2024

Conversation

LukasTy
Copy link
Member

@LukasTy LukasTy commented Feb 19, 2024

Discovered while working on #12097.
Noticed that adding a link to the API page with a hash (i.e. /x/api/date-field/#props) adds it to the list of broken links when we try to ignore errors from generated paths (at least hashes) of generated API paths.

Looked into the issue and it seems that our check was incorrect and we were adding all links to hashed API pages to the error list... 🙈
There were a few legitimately broken links, fixed those.
There was a missing check (which exists on the Core repo) for dynamically generated base hooks-api or components-api paths as well. 🙈

@LukasTy LukasTy added the core Infrastructure work going on behind the scenes label Feb 19, 2024
@LukasTy LukasTy self-assigned this Feb 19, 2024
Comment on lines -6 to -7
- https://mui.com/material-ui/api/input-base/#InputBase-prop-disableInjectingGlobalStyles
- https://mui.com/material-ui/api/menu-item/#css
Copy link
Member Author

Choose a reason for hiding this comment

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

These are fixed in mui/material-ui#41185

@mui-bot
Copy link

mui-bot commented Feb 19, 2024

Copy link
Member

@alexfauquette alexfauquette left a comment

Choose a reason for hiding this comment

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

Nice fix

docs/scripts/reportBrokenLinks.js Outdated Show resolved Hide resolved
docs/scripts/reportBrokenLinks.js Show resolved Hide resolved
docs/scripts/reportBrokenLinks.js Outdated Show resolved Hide resolved
@LukasTy LukasTy added the needs cherry-pick The PR should be cherry-picked to master after merge label Feb 19, 2024
@LukasTy LukasTy merged commit 42d6bae into mui:next Feb 19, 2024
18 checks passed
@LukasTy LukasTy deleted the fix-docs-link-check branch February 19, 2024 16:08
LukasTy added a commit to LukasTy/mui-x that referenced this pull request Feb 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Infrastructure work going on behind the scenes needs cherry-pick The PR should be cherry-picked to master after merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants