Skip to content

site: add SEO metadata (rel=me, JSON-LD) and crawlable GitHub URL#329

Merged
ojongerius merged 1 commit intomainfrom
site/seo-jsonld-rel-me
May 6, 2026
Merged

site: add SEO metadata (rel=me, JSON-LD) and crawlable GitHub URL#329
ojongerius merged 1 commit intomainfrom
site/seo-jsonld-rel-me

Conversation

@ojongerius
Copy link
Copy Markdown
Contributor

@ojongerius ojongerius commented May 6, 2026

What

Adds three SEO additions to the Starlight docs site (site/):

  1. <link rel="me"> in <head> pointing to https://github.com/agent-receipts — confirms the GitHub org is "us" for IndieAuth / verified-link consumers.
  2. schema.org JSON-LD in <head> — a WebSite with a publisher Organization whose sameAs points to the GitHub org. Helps search engines connect the site to the org's knowledge-graph entity.
  3. SocialIcons component override — the GitHub social link now contains the visible anchor text github.com/agent-receipts (derived from the configured href) on desktop (≥ 50em). On mobile the text is sr-only-style hidden via clip-path: inset(50%) — still in the DOM and crawlable, but the header keeps its icon-only layout on phones.

Why

The site previously emitted no machine-readable signal connecting agentreceipts.ai to the GitHub org, and the only GitHub link was an icon-only social anchor (no crawlable text). Together that meant search engines had to infer the relationship. These three additions give them an explicit, conventional signal on every page.

Notes for review

  • Schema choice: I went with WebSite + publisher: Organization rather than SoftwareApplication. The latter is intended for installable apps and would have flagged "missing applicationCategory / operatingSystem" in structured-data validators. The chosen shape has no required-but-missing properties.
  • Match strategy in the override: the override checks icon === "github" rather than a hardcoded URL string-equality, and derives the visible text from the configured href. Single source of truth lives in the existing social array in astro.config.mjs.
  • No npm-org URL in sameAs: the npm registry confirms agnt-rcpt is a scope, not an npm Organization (the /-/org/agnt-rcpt endpoint returns 404), so I omitted the npm URL rather than ship a 404 in our schema.org markup.
  • No CI / workflow / spec / crypto changes. Site-only.

Checklist

  • Tests pass for all changed components — site has no test suite; verified the override against the Starlight 0.38.4 source (SocialIcons.astro, Head.astro, head schema) on GitHub for API compatibility.
  • Linter passes — N/A for .astro / config in this repo's lint setup.
  • No real keys or secrets in the diff.
  • Cross-language tests pass — N/A (site-only, no receipt format changes).
  • AGENTS.md updated — N/A (no structural changes).
  • Spec changes — N/A.

Note

I could not run pnpm install && pnpm build in my sandbox (no Node toolchain available). Please verify the build locally before merging.

Adds a `<link rel="me">` and a schema.org WebSite/Organization JSON-LD
block to every page so search engines can connect the site to its
GitHub org. Overrides Starlight's `SocialIcons` so the GitHub anchor
text on desktop reads "github.com/agent-receipts" (visually hidden
on mobile to keep the icon-only header layout).
@ojongerius ojongerius force-pushed the site/seo-jsonld-rel-me branch from 0d063f6 to a9ea858 Compare May 6, 2026 05:42
Copy link
Copy Markdown
Contributor

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 adds machine-readable SEO identity metadata to the Starlight docs site and makes the GitHub social link include crawlable text (visible on desktop, visually hidden on smaller viewports).

Changes:

  • Adds a <link rel="me"> and schema.org JSON-LD (WebSite + publisher: Organization) to the Starlight head configuration.
  • Overrides Starlight’s SocialIcons component to render the GitHub URL as text (desktop-visible, mobile visually hidden) while keeping icon rendering.

Reviewed changes

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

File Description
site/src/components/SocialIcons.astro Adds a Starlight component override that renders GitHub link text (desktop-visible, mobile visually hidden) alongside the icon.
site/astro.config.mjs Injects rel="me" + JSON-LD into <head> and wires up the SocialIcons override.

@ojongerius ojongerius merged commit 3f96b72 into main May 6, 2026
10 checks passed
@ojongerius ojongerius deleted the site/seo-jsonld-rel-me branch May 6, 2026 08:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants