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-infra] Reduce description max-length #43562

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Sep 1, 2024

Enforce max length in code, from 170 down to 160. I suspect we should go as far as 150, but maybe for another time.

See https://www.reddit.com/r/SEO/comments/14rc47l/meta_description_too_long_advice/. Meta descriptions are not used for SEO, but to improve the CTR on the search result. So if they are truncated, it defeats their purpose;

"nextjs 15 release", fits

SCR-20240901-ofje

"material ui v6 release", doesn't fit

SCR-20240901-oftn

I suspect that https://nextjs.org/blog/ are authors in the same underlying infra as https://vercel.com/blog/, but show in a different URL path. It's not a coincidence that all their posts's descriptions are short. This might look like a detail, but I think it's this kind of depth of execution difference that compounds and separates the great UX from the good ones.

Saw this from https://app.ahrefs.com/site-audit/2944028/data-explorer?columns=pageRating%2Curl%2Ctraffic%2ChttpCode%2Cdepth%2CmetaDescription%2CmetaDescriptionLength%2CnrMetaDescription%2Ccompliant&current=30-08-2024T023527&filterId=2864d4a78dbccdda9cf9629aa273bd61&issueId=c64d56c9-d0f4-11e7-8ed1-001e67ed4656.

@oliviertassinari oliviertassinari added the scope: docs-infra Specific to the docs-infra product label Sep 1, 2024
@mui-bot
Copy link

mui-bot commented Sep 1, 2024

Netlify deploy preview

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

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against 6474129

@oliviertassinari oliviertassinari added the enhancement This is not a bug, nor a new feature label Sep 1, 2024
@oliviertassinari oliviertassinari added bug 🐛 Something doesn't work and removed enhancement This is not a bug, nor a new feature labels Sep 1, 2024
Copy link
Contributor

@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 call 👍 This is also a good reminder that these kinds of best practices should be documented on Notion for future reference.

@oliviertassinari oliviertassinari merged commit 24bedf7 into mui:master Sep 2, 2024
24 checks passed
@oliviertassinari oliviertassinari deleted the try-to-reduce-description-max-length branch September 2, 2024 15:46
@oliviertassinari oliviertassinari added the regression A bug, but worse label Sep 5, 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 regression A bug, but worse scope: docs-infra Specific to the docs-infra product
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants