End-User Documentation

AI Docs Sync Workflow

AI Docs Sync Workflow

This contributor page summarizes the repository workflow for turning code changes into accurate, reviewable documentation updates.

Responsibilities

  • Backend and feature contributors identify docs-impact whenever public behavior changes.
  • Manual writers convert that impact into user-facing task pages, reference updates, troubleshooting notes, and release notes.
  • Reviewers check both technical accuracy and whether the docs answer the user task clearly.

Canonical Source

The full workflow details live in the source document below.

Example

1. Feature change lands
2. Docs-impact is identified
3. Manual pages are updated
4. Reviewer checks code and docs together