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] Fix navigation links #32851

Merged
merged 1 commit into from
May 23, 2022
Merged

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented May 21, 2022

Fix a couple of recent docs navigation regressions. https://app.ahrefs.com/site-audit/3524616/13/issues

We might want to look into implementing checks in the CI so we can have a faster feedback loop. I feel that I need to make this kind of fixes too frequently.

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label May 21, 2022
@mui-bot
Copy link

mui-bot commented May 21, 2022

No bundle size changes

Generated by 🚫 dangerJS against e66a355

Copy link
Contributor

@danilo-leal danilo-leal left a comment

Choose a reason for hiding this comment

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

Sweet, great catches!

@@ -37,7 +37,7 @@ The following chart illustrates how MUI's packages are related to one another:
<img src="/static/images/packages/mui-packages.png" style="width: 796px; margin-top: 4px; margin-bottom: 8px;" alt="The first half of the image shows @mui/material and @mui/base as component libraries, and @mui/system and styled engines as styling solutions, both under the MUI Core umbrella. The second half shows @mui/x-data-grid and @mui/x-date-pickers as components from MUI X."/>

In this article, we'll only cover the MUI Core packages.
Check the [MUI X overview](/x/getting-started/overview) for more information about our collection of advanced components.
Check the [MUI X overview](/x/advanced-components/) for more information about our collection of advanced components.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Check the [MUI X overview](/x/advanced-components/) for more information about our collection of advanced components.
Check the [MUI X overview](/x/overview/) for more information about our collection of advanced components.

Should we change the URL for this page? 🤔

Copy link
Member Author

@oliviertassinari oliviertassinari May 23, 2022

Choose a reason for hiding this comment

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

For now, it's a 404 (proof https://mui.com/x/overview/) but agrees I believe @samuelsycamore works on this in mui/mui-x#4692, to consider the change if/when merged.

Copy link
Contributor

@mapache-salvaje mapache-salvaje left a comment

Choose a reason for hiding this comment

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

Agreed that we could really benefit from an automated check for broken links! Aside from just typos, future docs revisions will continue to break older links, and they can be difficult to keep track of.

@oliviertassinari oliviertassinari changed the title [docs] Navigation fixes [docs] Fix navigation links May 23, 2022
@oliviertassinari oliviertassinari merged commit 80569a2 into mui:master May 23, 2022
@oliviertassinari oliviertassinari deleted the seo-fixes-v4 branch May 23, 2022 19:31
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants