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.

Sign up for GitHub

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

Jump to bottom

[docs] Fix SEO regression, update meta #40306

Merged
merged 1 commit into from
Dec 25, 2023
Merged

[docs] Fix SEO regression, update meta #40306

merged 1 commit into from
Dec 25, 2023

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Dec 24, 2023 •
edited

Act on https://groups.google.com/a/mui.com/g/devex/c/Y-p_Qv2sDlA. The idea is to have a single long format, with concatenation based on the context (e.g. for SEO, we need to mention React, in the docs, we don't), but with the same content in as many places as possible (GitHub repository description, npm description, social cards, Twitter account description, etc.).

SEO title: between 50 and 60 characters
SEO description: between 120 and 158 characters

One-line mobile view: ~60 characters
Two lines: between 120 and 158 characters

Material UI

  • SEO description: Material UI is an open-source React component library that implements Google's Material Design. It's comprehensive and can be used in production out of the box.
  • Two lines: An open-source React component library that implements Google's Material Design.
  • SEO title: Material UI: React components that implement Material Design
  • One-line mobile view: Component library that implements Google's Material Design.

Joy UI

  • SEO description: Joy UI is an open-source React component library that implements MUI's own in-house design principles. It's comprehensive and can be used in production out of the box.
  • Two lines: An open-source React component library that implements MUI's own in-house design principles.
  • SEO title: Joy UI: React components that implement MUI's own in-house principles
  • One-line mobile view: Component library that implements MUI's own in-house design principles.

Base UI

  • SEO description: Base UI is a library of headless ("unstyled") React components and low-level hooks. You gain complete control over your app's CSS and accessibility features.
  • Two lines: A library of unstyled React components and low-level hooks. With Base UI, you gain complete control over your app's CSS and accessibility features.
  • SEO title: Base UI: Unstyled React components and low-level hooks
  • One-line mobile view: Unstyled React components and low-level hooks.

MUI System

  • SEO description: MUI System is a set of CSS utilities to help you build custom designs more efficiently. It makes it possible to rapidly lay out custom designs.
  • Two lines: A set of CSS utilities to help you build custom designs more efficiently. It makes it possible to rapidly lay out custom designs.
  • SEO title: MUI System: CSS utilities to quickly lay out custom designs
  • One-line mobile view: CSS utilities for rapidly laying out custom designs.

MUI X

  • SEO description: Build complex and data-rich applications using a growing list of advanced React components, like the Data Grid, Date and Time Pickers, Charts, and more!
  • Two lines: /
  • SEO title: MUI X: Advanced React components for complex use cases
  • One-line mobile view: Advanced components for complex use cases.

The work on this is triggered by #32181

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Dec 24, 2023
oliviertassinari
oliviertassinari commented Dec 24, 2023
View reviewed changes
docs/pages/index.tsx
Comment on lines -23 to +24
title="MUI: Move faster with intuitive React UI tools"
description="MUI offers a comprehensive suite of free UI tools to help you ship new features faster.
Start with Material UI, our fully-loaded component library, or bring your own design
system to our production-ready components."
title="MUI: The React component library you always wanted"
description="MUI provides a simple, customizable, and accessible library of React components. Follow your own design system, or start with Material Design."
Copy link
Member Author

Choose a reason for hiding this comment

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

A direct revert from e7b9793#r135660732

Copy link
Member Author

Choose a reason for hiding this comment

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

Lived in production with 48e7dfc.

@mui-bot
Copy link

mui-bot commented Dec 24, 2023 •
edited

Netlify deploy preview

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against 9805baa

@oliviertassinari oliviertassinari changed the title [docs] Restore to previous caption [docs] Fix SEO regression Dec 24, 2023
@oliviertassinari oliviertassinari force-pushed the docs-caption branch 2 times, most recently from 48bb532 to 49d1c81 Compare December 24, 2023 21:33
oliviertassinari referenced this pull request Dec 24, 2023
@danilo-leal
[website] Update product descriptions and social preview images (#32181)
e7b9793
@oliviertassinari oliviertassinari mentioned this pull request Dec 24, 2023
Merged
1 task
@mnajdova
Copy link
Member

The Core descriptions look good 👍

MUI X
SEO description: Build complex and data-rich applications using a growing list of advanced React components, like the Data Grid, Date and Time Pickers, Charts, and more!
Two lines: /
SEO title: MUI X: Advanced React components for complex use cases
One-line mobile view: Advanced components for complex use cases.

What's the reason for not defining two lines text here?

@oliviertassinari
Copy link
Member Author

oliviertassinari commented Dec 25, 2023 •
edited

What's the reason for not defining two lines text here?

@mnajdova I didn't see a case where we needed to render it with MUI X. All the long-form instances where equivalent to the SEO ones.

oliviertassinari
oliviertassinari commented Dec 25, 2023
View reviewed changes
docs/pages/x.tsx
title="MUI X: Advanced and powerful components for complex use cases."
title="MUI X: Advanced React components for complex use cases"
Copy link
Member Author

Choose a reason for hiding this comment

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

SEO titles don't have dots

@mnajdova
Copy link
Member

I am merging, will be preparing the release PR.

@mnajdova mnajdova merged commit 312d5ab into mui:master Dec 25, 2023
22 checks passed
mnajdova pushed a commit to mnajdova/material-ui that referenced this pull request Jan 9, 2024
@oliviertassinari @mnajdova
[docs] Fix SEO regression (mui#40306)
62cddc8
@oliviertassinari oliviertassinari added the website Pages that are not documentation-related, marketing-focused. label Feb 26, 2024
@oliviertassinari oliviertassinari changed the title [docs] Fix SEO regression [docs] Fix SEO regression, update meta Feb 26, 2024
@oliviertassinari oliviertassinari deleted the docs-caption branch February 26, 2024 23:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mnajdova mnajdova mnajdova approved these changes

Assignees
No one assigned
Labels
docs Improvements or additions to the documentation website Pages that are not documentation-related, marketing-focused.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@oliviertassinari @mui-bot @mnajdova