Docs Sync

Overview

Identify documentation gaps and inaccuracies within the requested topic or diff using implementation evidence.

Scope and authorization

For audit or proposal-only requests, report findings without editing. When the user requests updates or has approved a plan, complete the scoped edits and verification without asking again. Ask only for unresolved behavior, scope, release timing, or additional authority. Apply the repository's Documentation Release Timing policy before including unreleased behavior in docs/.

Workflow

1. Confirm scope and base branch
   • Identify the current branch and default branch (usually main).
   • Prefer analyzing the current branch to keep work aligned with in-flight changes.
   • Use a branch diff only for a branch-scoped request. A requested topic or released-doc correction remains in scope even when unrelated to the current branch diff.
   • Avoid switching branches if it would disrupt local changes. Prefer read-only inspection such as git show main:<path>. If a separate checkout is genuinely required, stop and obtain the explicit approval required by AGENTS.md before creating or switching a worktree.