Skip to content

Conversation

@josh-wong
Copy link
Member

Description

This PR fixes an issue with the social card preview not showing when sharing the home page on social media platforms that show site preview images.

For some reason, the social card image that we added to docusaurus.config.js in #1038 isn't being applied when sharing the home page. To work around this, we can manually set the image this way, according to the Markdown front-matter section in the Docusaurus docs.

Related issues and/or PRs

Changes made

  • Added the social card preview to the front-matter metadata of the home page.

Checklist

The following is a best-effort checklist. If any items in this checklist are not applicable to this PR or are dependent on other, unmerged PRs, please still mark the checkboxes after you have read and understood each item.

  • I have updated the side navigation as necessary.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation to reflect the changes.
  • Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.).
  • My changes generate no new warnings.
  • Any dependent changes in other PRs have been merged and published.

Additional notes (optional)

N/A

For some reason, the social card image that we added to **docusaurus.config.js** isn't being applied when sharing the home page. To work around this, we can manually set the image this way, according to the Docusaurus docs.
@josh-wong josh-wong added the bugfix Fix that resolves bugs label Mar 21, 2025
@josh-wong josh-wong self-assigned this Mar 21, 2025
@josh-wong josh-wong merged commit 2046a2b into main Mar 21, 2025
1 check passed
@josh-wong josh-wong deleted the fix-social-card-logo-on-homepage branch March 21, 2025 12:20
josh-wong added a commit that referenced this pull request May 14, 2025
For some reason, the social card image that we added to **docusaurus.config.js** isn't being applied when sharing the home page. To work around this, we can manually set the image this way, according to the Docusaurus docs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugfix Fix that resolves bugs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant