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] Improve social sharing of docs pages #34346

Merged
merged 1 commit into from Sep 20, 2022
Merged

[docs] Improve social sharing of docs pages #34346

merged 1 commit into from Sep 20, 2022

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Sep 17, 2022 •
edited

Same rationale as #32536. When sharing a page to a specific docs page, the social image creates confusion https://twitter.com/olivtassinari/status/1571093885644046339.

Going forward, I think that we have two opportunities to improve, by increasing effort & outcome:

  1. Something like [blog] Remove default social card #32536 (comment), one very low distraction illustration, like "Material UI", one per product
  2. Something custom for each page https://www.notion.so/mui-org/Page-image-generator-75bc177fefe64c0b899a42a6f919a907

A bit related to #32181

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Sep 17, 2022
oliviertassinari
oliviertassinari commented Sep 17, 2022
View reviewed changes
docs/src/modules/components/TopLayoutBlog.js
const { canonicalAs } = pathnameToLanguage(router.asPath);
const card =
headers.card === 'true'
? `https://mui.com/static${router.pathname}/card.png`
? `https://mui.com/static/blog/${slug}/card.png`
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 small fix. It helps to search in the codebase for places were the images inside the blog folder are used.

@mui-bot
Copy link

mui-bot commented Sep 17, 2022 •
edited

No bundle size changes

Generated by 🚫 dangerJS against a4e6d04

danilo-leal
danilo-leal approved these changes Sep 20, 2022
View reviewed changes
Copy link
Contributor

@danilo-leal danilo-leal left a comment

Choose a reason for hiding this comment

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

Looks good! I'd love to generate automatically the ones I've been manually doing for each blog post (see attachment)－we could then think about similar ones for doc pages.

Screen Shot 2022-09-19 at 23 50 02

@oliviertassinari
Copy link
Member Author

we could then think about similar ones for doc pages

Agree, a couple of options:

  • text as in this example
  • screenshot of a main demo of the page
  • screenshot of the component illustration on the page component cataloge (not built yet)

@oliviertassinari oliviertassinari merged commit 0638fff into mui:master Sep 20, 2022
@oliviertassinari oliviertassinari deleted the social-card-clarity branch September 20, 2022 07:11
alexfauquette pushed a commit to alexfauquette/material-ui that referenced this pull request Oct 14, 2022
@oliviertassinari @alexfauquette
[docs] Improve social sharing of docs pages (mui#34346)
877fac0
daniel-rabe pushed a commit to daniel-rabe/material-ui that referenced this pull request Nov 29, 2022
@oliviertassinari
[docs] Improve social sharing of docs pages (mui#34346)
f9411ed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@danilo-leal danilo-leal danilo-leal approved these changes

@samuelsycamore samuelsycamore Awaiting requested review from samuelsycamore

Assignees
No one assigned
Labels
docs Improvements or additions to the documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@oliviertassinari @mui-bot @danilo-leal