docs: add Open Graph and Twitter card meta tags to docs page#32
Open
dmchaledev wants to merge 1 commit into
Open
docs: add Open Graph and Twitter card meta tags to docs page#32dmchaledev wants to merge 1 commit into
dmchaledev wants to merge 1 commit into
Conversation
Adds og:type, og:site_name, og:title, og:description, og:url, twitter:card, twitter:title, twitter:description, and a canonical link to docs/index.html. Without these, social shares of the docs page show a bare link with no preview card. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ByPYveekU5QnrTykFFo582
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The interactive API docs page (
docs/index.html) had a<meta name="description">tag but no social-sharing or canonical metadata. When someone shareshttps://hailbytes.github.io/hailbytes-api-docs/on LinkedIn, Slack, X, or Discord, it renders as a bare link with no preview.Changes:
og:type,og:site_name,og:title,og:description,og:url(Open Graph — Facebook, LinkedIn, Slack, Discord)twitter:card,twitter:title,twitter:description(Twitter/X summary card)<link rel="canonical">pointing to the GitHub Pages URL — prevents duplicate-content penalties if the page is ever mirroredNo functional changes to the Redoc viewer or navigation; purely
<head>additions.Test plan
https://hailbytes.github.io/hailbytes-api-docs/into OpenGraph.xyz or the Twitter Card Validator after the page re-deploys and confirm the preview card shows the correct title and descriptionvalidate-openapi.yml) still passes — no OpenAPI spec changes were madedeploy-docs.yml) copies the updatedindex.htmlto_site/as before🤖 Generated with Claude Code
https://claude.ai/code/session_01ByPYveekU5QnrTykFFo582
Generated by Claude Code