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] Update link to add custom color in palette #39359

Conversation

ZeeshanTamboli
Copy link
Member

@ZeeshanTamboli ZeeshanTamboli added bug 🐛 Something doesn't work docs Improvements or additions to the documentation package: material-ui Specific to @mui/material labels Oct 9, 2023
@mui-bot
Copy link

mui-bot commented Oct 9, 2023

Netlify deploy preview

https://deploy-preview-39359--material-ui.netlify.app/

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against c138f80

@ZeeshanTamboli ZeeshanTamboli marked this pull request as ready for review October 9, 2023 15:41
Copy link
Member

@samuelsycamore samuelsycamore left a comment

Choose a reason for hiding this comment

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

good catch!

@ZeeshanTamboli ZeeshanTamboli merged commit 53c792d into mui:master Oct 9, 2023
25 checks passed
@ZeeshanTamboli ZeeshanTamboli deleted the docs-update-custom-color-link-to-palette branch October 9, 2023 16:41
@DiegoAndai
Copy link
Member

Thanks for catching and fixing this. We have some checks for broken links; do you know if these cases are not covered?

@ZeeshanTamboli
Copy link
Member Author

Thanks for catching and fixing this. We have some checks for broken links; do you know if these cases are not covered?

I am not aware that we have checks for broken links.

@DiegoAndai
Copy link
Member

I was thinking about yarn docs:link-check, which runs in test_static, so it's only for the docs. Maybe we should create an issue to be able to run the same check on packages? 🤔

@ZeeshanTamboli
Copy link
Member Author

ZeeshanTamboli commented Oct 10, 2023

Yes maybe we could. That would be great. @alexfauquette might have more insights. I see it was introduced in #34588. It seems we also utilize ahrefs to identify broken links.

@alexfauquette
Copy link
Member

Yes maybe we could. That would be great. @alexfauquette might have more insights. I see it was introduced in #34588. It seems we also utilize #34588 (review) to identify broken links.

Yes I have :)

ahrefs is a scroller that implies two limitations:

  • it only detects 400/500 code error so the hash is not taken into account
  • it only detects visible links (for example in pricing page collapsed links will not be scrolled)

About docs:link-check it tries to fix the first drawback by getting all markdown files, and it generate two lists:

  • one with all the pages and their existing hash
  • one with all the internal links

and we check if all internal links exist (the page and the hash)

For now, API pages are ignored because we don't handle the hash added by the page rendering (for example https://mui.com/material-ui/api/alert/#import or now https://mui.com/material-ui/api/alert/#Alert-prop-children) so it would put to many false positive.

For your usecase, you should modify the parseDocFolder such that it parse the api JSON files in addition to the markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug 🐛 Something doesn't work docs Improvements or additions to the documentation package: material-ui Specific to @mui/material
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants