How to keep Astro Starlight docs accurate after a green build

Description and use

Starlight’s built‑in checks miss outdated content; a workflow that links product PRs to docs edits, plus link, API, and translation tracking tools, keeps documentation accurate.

Problem

A green build only verifies site structure; it does not ensure that content, such as how‑to sentences, reflects recent product changes.

Outcome

Implementing the checklist and optional EkLine integration closes the gap between product changes and documentation, ensuring accurate how‑to content and consistent translations without modifying Starlight.

Workflow

• 1. Extend docsSchema() to include owner/last‑reviewed fields.
• 2. Add starlight-links-validator to CI to catch broken links.
• 3. Generate API reference with starlight-openapi from the spec.
• 4. Track translations with Git‑based tooling such as Lunaria.
• 5. After each release, manually review high‑traffic how‑to pages against shipped changes. (Optional)
• 6. Use EkLine’s Automatic PR Review to auto‑open docs PRs or add suggestions when product PRs modify relevant components.

Evidence

A green build tells you the site is well‑formed: frontmatter matches its schema, internal links resolve once you add a validator, and API pages render from your spec.

Source

Translations inherit English errors, and Git‑based tracking can flag them once the English page is fixed.

Source

A content check driven by product pull requests closes the gap, with Starlight unchanged.

Source