docs: improve AEO (JSON-LD, homepage content, headings, links)#56
Open
joalavedra wants to merge 1 commit into
Open
docs: improve AEO (JSON-LD, homepage content, headings, links)#56joalavedra wants to merge 1 commit into
joalavedra wants to merge 1 commit into
Conversation
Address the AEO audit gaps: - Add JSON-LD structured data via a reusable src/lib/jsonld.tsx helper: Organization + WebSite + SoftwareApplication on the homepage, and TechArticle on every content page (23/24 pages). - Enrich the homepage below the hero with an H1, ~350 words, section headings, internal links to key docs, and external citations. - Expand the thin Getting Started page with real content and links. - Ensure every content page has at least 3 contextual internal links and 2 external citation links (Shamir's Secret Sharing, WebAuthn, RFC 6238, RFC 7519, OWASP, OpenAPI, etc.) via "Related" sections. - De-route the thin ui_warning partial by moving it to apis/_components/ so it is no longer a standalone page (still imported by the Swagger pages). Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
1 participant
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.
Summary
Addresses the AEO audit gaps. Stacked on #55 (the hydration fix) — merge #55 first; this PR's diff then shows only the AEO changes.
What changed
src/lib/jsonld.tsxhelper.Organization+WebSite+SoftwareApplicationon the homepage;TechArticleon every content page. 23/24 pages now emit valid JSON-LD.H1, ~350 words, section headings (What you can do/How it works/Explore the APIs), internal links to key docs, and external citations — below the existing hero, so the landing design is preserved.H1and a clean heading hierarchy.apis/ui_warning.mdx→apis/_components/ui-warning.mdx. It's a shared Swagger warning partial, not a real page; the 3 Swagger pages still import it.Verification (headless browser, production build)
Test plan
🤖 Generated with Claude Code