Skip to content

[plan] Add JSON-LD schema markup to docs site homepage #30483

@github-actions

Description

@github-actions

From the GEO Audit Report (discussion #30401): neither the docs site nor the README has JSON-LD schema markup (0/16). This is the single highest-impact gap for AI Knowledge Graph inclusion.

Approach

Add JSON-LD structured data to the docs site homepage (docs/src/pages/index.astro or via Astro head injection in astro.config.mjs):

Schemas to add:

  1. WebSite + Organization — establishes entity identity
  2. SoftwareApplication — describes gh-aw as a tool
  3. FAQPage — populated from existing docs FAQ content
  4. potentialAction: SearchAction — enables agent discoverability

Example snippet:

{
  "`@context`": "(schema.org/redacted)",
  "`@type`": ["WebSite", "SoftwareApplication"],
  "name": "GitHub Agentic Workflows",
  "url": "https://github.github.com/gh-aw/",
  "description": "Write agentic workflows in natural language using markdown, run them as GitHub Actions.",
  "applicationCategory": "DeveloperApplication",
  "operatingSystem": "Any"
}

Files to Modify

  • docs/src/pages/index.astro or equivalent — inject <script type="application/ld+json"> in <head>
  • Alternatively, use Astro's <head> slot in the Starlight config

Acceptance Criteria

  • Docs site homepage includes <script type="application/ld+json"> with at least WebSite and SoftwareApplication schemas
  • JSON-LD validates without errors using Google's Rich Results Test
  • Organization schema includes name, url, and sameAs pointing to the GitHub repo

Generated by Plan Command for issue #discussion #30401 · ● 2.8M ·

  • expires on May 8, 2026, 1:52 AM UTC

Metadata

Metadata

Labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions