How to keep Astro Starlight docs accurate after a green build

说明与用途

Starlight 内置检查无法发现过时内容，需通过将产品 PR 与文档编辑关联的工作流，以及链接、API 和翻译跟踪工具，保持文档准确。

问题

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

结果

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.

工作流

• 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.

证据

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.

来源

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

来源

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

来源