Skip to content

feat(docs): improve search + LLM discoverability#870

Merged
EmersonBraun merged 1 commit into
mainfrom
feat/docs-seo-discoverability
May 19, 2026
Merged

feat(docs): improve search + LLM discoverability#870
EmersonBraun merged 1 commit into
mainfrom
feat/docs-seo-discoverability

Conversation

@EmersonBraun
Copy link
Copy Markdown
Collaborator

What

Docs already had a strong SEO base (robots AI-bot allowlist, llms.txt/llms-full.txt, per-page OG + canonical, breadcrumb/article JSON-LD). This closes the remaining findability gaps.

Changes

  • json-ld: render via dangerouslySetInnerHTML with < escaped to <. React was HTML-escaping <script> text children, corrupting every structured-data block (home Organization/SoftwareApplication/WebSite, all docs breadcrumb + TechArticle) so Google / LLM crawlers couldn't parse it. Content is app-controlled + escaped — canonical Next.js JSON-LD pattern.
  • sitemap: was docs-only. Add blog posts, learn steps, showcase entries, and /learn /blog /showcase /stack /community /evals. ~33 URLs now discoverable.
  • robots: allow /api/og (was blocked by /api/ disallow) so OG preview images are crawlable for image search / social.
  • not-found: noindex the 404 to keep soft-404s out of the index.

Verification

  • tsc --noEmit clean on @agentskit/docs-next
  • Post-deploy: validate rich results at https://validator.schema.org, submit sitemap in Search Console (see PR thread)

Not in scope

PT hreflang in sitemap — deferred until EN stabilises per i18n roadmap.

- json-ld: render via dangerouslySetInnerHTML with < escaped so
  structured data survives in the DOM (React was HTML-escaping the
  <script> children, breaking every breadcrumb/article/org block)
- sitemap: add blog posts, learn steps, showcase entries, and the
  /learn /blog /showcase /stack /community /evals routes (was docs-only)
- robots: allow /api/og so OG preview images are crawlable
- not-found: noindex 404 to keep soft-404s out of the index
@vercel
Copy link
Copy Markdown

vercel Bot commented May 19, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
agentskit-doc Ready Ready Preview, Comment May 19, 2026 6:19pm

@github-actions
Copy link
Copy Markdown
Contributor

@EmersonBraun EmersonBraun merged commit bb40c6e into main May 19, 2026
13 checks passed
@EmersonBraun EmersonBraun deleted the feat/docs-seo-discoverability branch May 19, 2026 18:26
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.

1 participant