Skip to content

[docs-infra] Crash build when description is over 170 characters #612

@oliviertassinari

Description

@oliviertassinari

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: -

Metadata

Metadata

Assignees

Labels

docsImprovements or additions to the documentation.scope: all componentsWidespread work has an impact on almost all components.scope: code-infraChanges related to the core-infra product.type: regressionA bug, but worse, it used to behave as expected.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions