Feature: Structured Data (JSON-LD)
Purpose
- Feature name: Structured data (JSON-LD)
- Why this feature exists: Provide search engines with explicit, machine-readable context about the site and author.
Scope
In scope
- Person schema
- Website schema
- JSON-LD script injection
Out of scope
- Open Graph and Twitter metadata
- per-project metadata overrides
- site URL configured for structured data output
Procedure / Content
Feature summary
- Feature name: Structured data (JSON-LD)
- Feature group: SEO, metadata, and structured data
- Technical summary: Generates JSON-LD for Person and Website schema definitions and injects them in the document head.
- Low-tech summary: Helps search engines understand who the site is about and what it represents.
Feature in action
- Where to see it working: Any route, inspect the JSON-LD scripts in the page head.
Confirmation Process
Manual
- Steps: Open a page and inspect JSON-LD scripts in DevTools.
- What to look for: Valid JSON-LD with expected schema types.
- Artifacts or reports to inspect: Schema validation tools.
Tests
- JSON-LD scripts missing or invalid.
- Incorrect schema properties or URLs.
Long-term maintenance notes
- Update schema values if site identity changes.
- Revalidate structured data when metadata strategy changes.
Source code references (GitHub URLs)
ADRs
Runbooks
Additional internal references
External reference links
Validation / Expected outcomes
- Structured data scripts are present and valid.
Failure modes / Troubleshooting
- Invalid JSON-LD: validate schema output and update tests.
References