Docs and Updates

Docs and Updates use case — run docs and release-style updates from one source.

What this is (short answer): A single, markdown-first content system that hosts canonical documentation and short release-style updates together, preserving metadata, canonical URLs, and easy distribution so both developer docs and product updates stay consistent and discoverable by humans and LLMs.

Why this helps

• Keeps terminology, links, and canonical URLs consistent across docs and updates.
• Single metadata model simplifies SEO and distribution workflows.
• Easier editorial workflow: update docs and ship short release notes from the same repository.

When to use

• Your product has technical docs plus frequent release notes or changelogs.
• You want canonical pages for features while publishing short updates.

Suggested setup

1. Keep long-form reference docs in a docs collection.
2. Publish short release notes or updates in an updates collection but cross-link to docs.
3. Use the same metadata fields (title, datePublished, canonical) for both types.
4. Add an FAQ block to docs for common update-related questions (migration notes, breaking changes).

Implementation checklist

• Add last updated: 2026-04-19 on top of each page.
• Ensure canonical URL is set to the primary doc page.
• Add short 40–60 word extractable summary at the top (for AI snippets).
• Include an FAQ schema block for common questions.

Example

• Link docs and updates bidirectionally so an update references the affected doc and the doc links to the update.