Add Open Graph and canonical meta tags to API docs page#25
Open
dmchaledev wants to merge 1 commit into
Open
Conversation
Social sharing links to the docs site currently show a bare URL with no preview card. Adding og: and twitter:card tags ensures Slack, LinkedIn, and Twitter unfurl the page with a title and description. Also expands the meta description to mention SAT alongside ASM, and adds a canonical link so search engines consolidate any duplicate URL variants. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011XQtZhPdawDYz3oxovQeXW
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.
Problem
When anyone shares the docs URL on Slack, LinkedIn, or Twitter, the link unfurls as a bare URL — no title, no description, no preview card. For a documentation site whose primary distribution channel is developer communities, this is a missed opportunity on every share.
Change
Adds 9 lines to
docs/index.html:og:type,og:url,og:title,og:description— standard Open Graph tags read by Slack, LinkedIn, Discord, iMessage, and most modern link previewerstwitter:card,twitter:title,twitter:description— Twitter/X-specific tags that render asummarycard instead of a plain link<link rel="canonical">— tells search engines the authoritative URL, consolidating any PageRank from GitHub Pages URL variants (with/without trailing slash,www, etc.)<meta name="description">to mention SAT alongside ASMBefore / After
hailbytes.github.io/hailbytes-api-docs/Testing
No build step needed — this is a static HTML change. The deploy workflow copies
docs/index.htmlto_site/index.htmlunchanged, so the tags will be live after the next deployment.Generated by Claude Code