[enhancement] +share card details, and post inspector instructions#60
[enhancement] +share card details, and post inspector instructions#60surfaceowl merged 1 commit intomainfrom
Conversation
There was a problem hiding this comment.
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
authorandarticle:published_timemeta 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. |
There was a problem hiding this comment.
[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.
| - 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. |
| <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)"> |
There was a problem hiding this comment.
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.
| <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)"> |
| <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 --> |
There was a problem hiding this comment.
[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.
| <!-- 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. --> |
merging share card tweaks (e.g. og:author ) and contributing instructions for LinkedIn Post Inspector