SEO: JSON-LD structured data and improved title/description frontmatter#3157
Conversation
…started sections Generates a Schema.org TechArticle JSON-LD block in <head> for all pages under /docs/installation/* and /docs/getting-started/*. Scoped by URL path so child pages are covered without requiring frontmatter changes. Maps existing frontmatter fields (title, description, pubDate, modDate) to standard Schema.org properties. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Adds gitignore patterns for CLAUDE.local.md, .claude/, /audit/, *.audit.csv, and octopus-writing-guide.md so local working files used with Claude Code are never accidentally committed. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…tting-started sections Updated title and description fields across all 54 pages in /installation/* and /getting-started/* to meet SEO targets: titles under 46 chars, descriptions 150-160 chars with active voice and a clear CTA. Previous titles were vague (e.g. "SQL Database", "File Storage") and descriptions were too short to render in search snippets. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Sam Irons seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
|
Pull request environment is available at https://stoctodocspr3157.z22.web.core.windows.net. You can view the ephemeral environment status in Octopus Deploy. This environment will be automatically deprovisioned when the pull request is closed, or after 7 days of inactivity. |
steve-fenton-octopus
requested review from
KMajkrzakOctopus and
tonykelly-octopus
and removed request for
BobJWalker
|
Pull request environment is available at https://stoctodocspr3157.z22.web.core.windows.net. You can view the ephemeral environment status in Octopus Deploy. This environment will be automatically deprovisioned when the pull request is closed, or after 7 days of inactivity. |
5 participants
Summary
<script type="application/ld+json">TechArticle structured data to all pages under/docs/installation/*and/docs/getting-started/*, scoped by URL pathname so child pages are correctly included.gitignoreto exclude local Claude Code context files, writing guides, and audit working files from the repotitleanddescriptionfrontmatter for all 54 pages in those two sections: titles trimmed to ≤46 chars with a clear subject, descriptions expanded to 150–160 chars with active voice and a next-step CTADetails
JSON-LD (
JsonLd.astro) — new component added toHtmlHead.astro. Emits aTechArticleblock withheadline,description,datePublished,dateModified,inLanguage,publisher, andisPartOf. Scoping is by URL pathname (notnavSection) so it works on child pages like/getting-started/first-deploymentthat don't inherit their parent's nav section.Frontmatter — previous titles were generic ("SQL Database", "File Storage", "Samples") and descriptions ranged from 34–234 chars, most too short to render in a search snippet. All 54 pages now have specific, benefit-oriented titles and full-length descriptions following the Octopus writing style guide.
Test plan
<head>for/docs/installation,/docs/installation/requirements, and/docs/getting-started/first-deployment(a child page)/docs/deployments)🤖 Generated with Claude Code