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 301 link to Base UI #40396

Merged
merged 2 commits into from
Jan 2, 2024

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Jan 2, 2024

Not the cleanest solution but it works to solve

https://app.ahrefs.com/site-audit/3524616/99/data-explorer?columns=pageRating%2Curl%2Ctraffic%2ChttpCode%2CredirectChainUrls%2CisRedirectLoop%2CincomingAllLinks%2CincomingRedirect%2Corigin&filterId=808b08e88c934ee19e04fdec4ed87a5a&issueId=c64d12c1-d0f4-11e7-8ed1-001e67ed4656&sorting=-pageRating


Extracted in #40531

Off-topic. When it comes to my own use of the components, the UX before #35938 likely work better with my workflows. Now, some would clearly prefer the new UX. Still, I think that it means that for the new approach to have a higher chance of winning, we have to fill the gaps with the older one:

  1. The title of the different pages are the same. https://mui.com/base-ui/react-input/ vs. https://mui.com/base-ui/react-input/components-api/ vs. https://mui.com/base-ui/react-input/hooks-api/. This is confusing when you are looking at the results on Google. See the ones that feel much better when searching for "Slider getAriaLabel"
  1. The TOCs don't sync correctly. It works in https://mui.com/material-ui/api/accordion/ but doesn't in https://mui.com/base-ui/react-switch/components-api/ (40px scroll offset bug and nested layer not synced)
  2. We have translations we shouldn't have, e.g.
    "/base-ui/react-popup/components-api/#popup": "Popup",
  3. When we rename components, we can hardly implement URL redirections because these are anchor links. We will need to invest into an anchor redirect logic.

Off-topic

Extracted in #40532

@alexfauquette I wonder if it would make sense to format more the HTML of the API pages, with h4, h3 so Google can more easily return relevant search results.

I have tried searching for the description of props on Google, can't really find helpful results. Maybe it's not a common workflow though, I don't recall ever trying this in the past as a user.

@oliviertassinari oliviertassinari added bug 🐛 Something doesn't work docs Improvements or additions to the documentation package: base-ui Specific to @mui/base labels Jan 2, 2024
@mui-bot
Copy link

mui-bot commented Jan 2, 2024

Netlify deploy preview

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

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against 602757c

@alexfauquette
Copy link
Member

I have tried searching for the description of props on Google, can't really find helpful results. Maybe it's not a common workflow though, I don't recall ever trying this in the past.

Just to add some information, you can search props in the algolia, and the link will let you bring you exactly on the props definition

image
image

Copy link
Member

@michelengelen michelengelen left a comment

Choose a reason for hiding this comment

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

LGTM! :shipit:

@oliviertassinari
Copy link
Member Author

oliviertassinari commented Jan 2, 2024

Just to add some information, you can search props in the algolia, and the link will let you bring you exactly on the props definition

@alexfauquette The only thing I would change here is the labels, making it clear that it's an API page:

new (❌):

vs. old (✅):

@oliviertassinari oliviertassinari merged commit 14391d3 into mui:master Jan 2, 2024
22 checks passed
@oliviertassinari oliviertassinari deleted the fix-301-inheritance branch January 2, 2024 18:51
mnajdova pushed a commit to mnajdova/material-ui that referenced this pull request Jan 9, 2024
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: base-ui Specific to @mui/base
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants