Skip to content

[enhancement] +share card details, and post inspector instructions#60

Merged
surfaceowl merged 1 commit intomainfrom
share-card-final-tweaks
May 25, 2025
Merged

[enhancement] +share card details, and post inspector instructions#60
surfaceowl merged 1 commit intomainfrom
share-card-final-tweaks

Conversation

@surfaceowl
Copy link
Contributor

merging share card tweaks (e.g. og:author ) and contributing instructions for LinkedIn Post Inspector

@surfaceowl surfaceowl requested a review from Copilot May 25, 2025 22:10
@surfaceowl surfaceowl self-assigned this May 25, 2025
@surfaceowl surfaceowl added the enhancement New feature or request label May 25, 2025
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR enhances social sharing capabilities and contributor guidance by adding metadata and inspection instructions.

  • Adds LinkedIn Post Inspector guidance to the contribution workflow in README.md
  • Inserts author and article:published_time meta tags for share cards in layout.html

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
README.md Added a bullet explaining how to use LinkedIn Post Inspector
PyBay/templates/layout.html Introduced <meta name="author"> and article:published_time tags

- Make changes to code
- Check for errors; check that the site displays correctly in multiple browsers and mobile.
- Inspect with other support tools (e.g., Lighthouse, https://metatags.io/ for share cards, social metadata. etc.) make sure share cards display correctly and metadata is correct.
- LinkedIn Post Inspector (https://www.linkedin.com/post-inspector/inspect/) gives a more detailed view of errors, but does not work through redirects. You can make your GitHub Codespace Public and test (same box as 'open browser' link when you first run it), and also check after changes are in production.
Copy link

Copilot AI May 25, 2025

Choose a reason for hiding this comment

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

[nitpick] This bullet combines two distinct instructions; consider splitting it into two separate list items—one introducing the LinkedIn Post Inspector tool and another describing how to test via a public Codespace—to improve readability.

Suggested change
- LinkedIn Post Inspector (https://www.linkedin.com/post-inspector/inspect/) gives a more detailed view of errors, but does not work through redirects. You can make your GitHub Codespace Public and test (same box as 'open browser' link when you first run it), and also check after changes are in production.
- Use LinkedIn Post Inspector (https://www.linkedin.com/post-inspector/inspect/) to get a detailed view of errors in share cards and metadata. Note that it does not work through redirects.
- To test share cards and metadata via LinkedIn Post Inspector, you can make your GitHub Codespace public (use the same box as the 'open browser' link when you first run it). Additionally, check the site after changes are in production.

Copilot uses AI. Check for mistakes.
<meta name="title" content="PyBay 2025 - 10th Annual Bay Area Python Dev Conference">
<meta name="description" content="10th Annual Python developer conference - longest running on the US West Coast. Join us in San Francisco!">

<meta name="author" content="Bay Area Python Association (BAPyA)">
Copy link

Copilot AI May 25, 2025

Choose a reason for hiding this comment

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

To ensure author metadata is recognized by Open Graph consumers, consider adding <meta property="article:author" content="Bay Area Python Association (BAPyA)"> alongside the standard author meta tag.

Suggested change
<meta name="author" content="Bay Area Python Association (BAPyA)">
<meta name="author" content="Bay Area Python Association (BAPyA)">
<meta property="article:author" content="Bay Area Python Association (BAPyA)">

Copilot uses AI. Check for mistakes.
<meta name="description" content="10th Annual Python developer conference - longest running on the US West Coast. Join us in San Francisco!">

<meta name="author" content="Bay Area Python Association (BAPyA)">
<!-- published time --> <!-- most sites will parse the date correctly if we leave time blank -->
Copy link

Copilot AI May 25, 2025

Choose a reason for hiding this comment

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

[nitpick] Consider consolidating these two inline comments into a single, more descriptive comment block above the article:published_time tag to maintain consistent commenting style.

Suggested change
<!-- published time --> <!-- most sites will parse the date correctly if we leave time blank -->
<!-- Published Time Metadata -->
<!-- This tag specifies the publication date of the article. -->
<!-- Most sites will parse the date correctly even if the time is left blank. -->

Copilot uses AI. Check for mistakes.
@surfaceowl surfaceowl merged commit 8edb289 into main May 25, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments