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] Crash build when description is over 170 characters #612

Open
oliviertassinari opened this issue Sep 14, 2024 · 0 comments
Open
Assignees
Labels
bug 🐛 Something doesn't work docs Improvements or additions to the documentation regression A bug, but worse scope: docs-infra Specific to the docs-infra product status: waiting for maintainer These issues haven't been looked at yet by a maintainer

Comments

@oliviertassinari
Copy link
Member

oliviertassinari commented Sep 14, 2024

Steps to reproduce

https://app.ahrefs.com/site-audit/6984453/data-explorer?columns=pageRating%2Curl%2Ctraffic%2ChttpCode%2Cdepth%2CmetaDescription%2CmetaDescriptionLength%2CnrMetaDescription%2Ccompliant&current=14-09-2024T115402&filterId=2864d4a78dbccdda9cf9629aa273bd61&issueId=c64d56c9-d0f4-11e7-8ed1-001e67ed4656 shouldn't be possible to happen in the first place.

SCR-20240914-pdyc

Current behavior

Build pass

Expected behavior

Build crash

SCR-20240914-pdav

I think we should bring this back from https://github.com/mui/material-ui/blob/64741295f7c233bd1782086e0187e52b668cb78c/packages/markdown/prepareMarkdown.js#L94. It would be a regression otherwise once Material UI eventually relies on the new docs-infra we are working on here. It's a regression compared to https://mui.com/base-ui/getting-started/ docs-infra.

Motivation

See mui/material-ui#43562 for why it matters. It's about having a description that fits into the Google Search results.

Your environment

npx @mui/envinfo
  Don't forget to mention which browser you used.
  Output from `npx @mui/envinfo` goes here.

Search keywords: -

@oliviertassinari oliviertassinari added status: waiting for maintainer These issues haven't been looked at yet by a maintainer docs Improvements or additions to the documentation bug 🐛 Something doesn't work regression A bug, but worse scope: docs-infra Specific to the docs-infra product labels Sep 14, 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 regression A bug, but worse scope: docs-infra Specific to the docs-infra product status: waiting for maintainer These issues haven't been looked at yet by a maintainer
Projects
None yet
Development

No branches or pull requests

2 participants