seo: add HowTo JSON-LD for the install / quickstart steps#100
Merged
Conversation
External SEO audit (Section 1 #2) flagged the absence of HowTo schema as one of four schema types missing from statewave.ai. Add it. Google deprecated HowTo rich results in the SERP in 2023, but the major answer engines (ChatGPT, Claude, Perplexity, Gemini) still consume HowTo structured data when ingesting pages — which is the audience this audit was largely worrying about. Worth shipping. Content: the four steps mirror statewave-docs/getting-started.md (port 8100 is correct — that's what the published docker-compose binds to, not 8000): 1. git clone + docker compose up -d → boot the stack 2. curl /healthz + /readyz → verify ready 3. POST /v1/episodes + /v1/memories/compile → store a memory 4. POST /v1/context → retrieve a bundle Each step links to the deep-link anchor in getting-started.md so crawlers can resolve the citation back to the source. totalTime PT5M matches the "5-minute quickstart" framing already used in the homepage CTA, the developers page, the FAQ, and llms.txt. Lives in index.html alongside the other static JSON-LD blocks (Organization, WebSite, SoftwareApplication, FAQPage) so crawlers without JS see all five entities on the first byte. Total of 5 ld+json blocks now (was 4); all parse as valid JSON in the seo-static test. Anti-drift: if the quickstart in statewave-docs changes (commands, port, route paths), update this block in the same commit — same rule as the proof figures.
Contributor
|
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
External SEO audit (Section 1 #2) flagged the absence of `HowTo` schema as one of four schema types missing from statewave.ai. Add it as the fifth static JSON-LD block in `index.html`.
Caveat: Google deprecated `HowTo` rich results in the SERP in October 2023. But the major answer engines (ChatGPT, Claude, Perplexity, Gemini) still consume `HowTo` structured data when ingesting pages — which is the audience this audit was largely worrying about. Worth shipping for the AEO value, with eyes open about Google.
Content
The four steps mirror `statewave-docs/getting-started.md` (port 8100 is correct — that's what the published `docker-compose` binds to, not 8000):
Each step links to the deep-link anchor in `getting-started.md` so crawlers can resolve the citation back to the source. `totalTime: PT5M` matches the "5-minute quickstart" framing already used in the homepage CTA, the developers page, the FAQ, and `llms.txt`.
Anti-drift
If the quickstart in `statewave-docs` changes (commands, port, route paths), update this block in the same commit — same rule as the proof figures.
Test plan