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

[core] Enforce 70 as the max width on the title on the docs #33819

Merged
merged 3 commits into from Aug 13, 2022

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Aug 6, 2022

A title too long issue was reported in https://app.ahrefs.com/site-audit/3524616/24/data-explorer?columns=pageRating%2Curl%2Ctraffic%2ChttpCode%2Cdepth%2Ctitle%2CtitlesLength%2CnrTitles%2Ccompliant&filterCollapsed=true&filterId=0f7e22d4a95d6f7840cd16096f4006c1&issueId=c64dac3a-d0f4-11e7-8ed1-001e67ed4656

Screenshot 2022-08-06 at 14 06 19

Screenshot 2022-08-11 at 18 54 41

At first, I was reluctant to enforce it, but in this example, it feels too long. I have proposed a new title that I feel goes quicker to the important message. While ahrefs recommends 60 characters, I have found blog posts that can hardly be shorter, e.g. https://blog.logrocket.com/build-type-safe-version-tailwind-css-sprinkles/ hence 70

The error message feels like this:

Screenshot 2022-08-06 at 14 10 25

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Aug 6, 2022
@mui-bot
Copy link

mui-bot commented Aug 6, 2022

No bundle size changes

Generated by 🚫 dangerJS against 28a8600

@oliviertassinari oliviertassinari marked this pull request as ready for review August 11, 2022 16:38
@samuelsycamore
Copy link
Member

60 feels too restrictive for sure. I'm actually surprised that 50-60 is the recommendation. 70 max feels like a solid goal, but maybe it's nice to have an extra 5 characters for wiggle room? For example "Our docs just got a major upgrade—here's what that means for you" feels good to me at 72, but it could be awkward to try to condense it to <70.

@oliviertassinari
Copy link
Member Author

oliviertassinari commented Aug 11, 2022

It's still within the threshold limit:

Screenshot 2022-08-11 at 21 28 35

@samuelsycamore
Copy link
Member

It's still within the threshold limit:

Screenshot 2022-08-11 at 21 28 35

My mistake, I see now that I had some extra random characters mixed in with my character counter. 😅 In that case I'm good with 70 as the max, and we can always revisit it later if we're constantly bumping into it for some reason.

Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
@oliviertassinari
Copy link
Member Author

oliviertassinari commented Aug 13, 2022

and we can always revisit it later if we're constantly bumping into it for some reason.

@samuelsycamore Yes agree, this way we can learn, we will have a feedback loop. In your example, if "Our docs just got a major upgrade—here's what that means for you" was indeed 72 characters, then the CI must have been red ❌, but it was green ✅: so something was not making sense. Hence why I have tested it in #33819 (comment) to debug.

@oliviertassinari oliviertassinari changed the title [docs] Enforce a max width on the title [docs] Enforce 70 as the max width on the title Aug 13, 2022
@oliviertassinari oliviertassinari added the core Infrastructure work going on behind the scenes label Aug 13, 2022
@oliviertassinari oliviertassinari changed the title [docs] Enforce 70 as the max width on the title [core] Enforce 70 as the max width on the title on the docs Aug 13, 2022
@oliviertassinari oliviertassinari merged commit ad36afc into mui:master Aug 13, 2022
@oliviertassinari oliviertassinari deleted the title-max-length branch August 13, 2022 09:50
daniel-rabe pushed a commit to daniel-rabe/material-ui that referenced this pull request Nov 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Infrastructure work going on behind the scenes docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants