doc-sync

Documentation Sync Rules

These rules apply when modifying files under src/. They define which documentation to update and when.

---

MANDATORY: Auto-Update Documentation

Whenever you implement changes, you MUST update the relevant documentation files. Never skip this step. If you are unsure which docs to update, consult the Documentation Trigger Map below and ask the user if needed — do not skip doc updates because you're uncertain.

Documentation Timing Gate (BLOCKING — requires user verification first)

You may NOT update documentation, rebuild docs, update task logs, or perform any batch-boundary step until ALL of the following gates have passed in order:

1. Agent Self-Evaluation Gate — You confirmed this is the best solution (see task.mdc → Agent Self-Evaluation Gate).
2. Visual Verification Gate — If the work affects front-end/UI/visual elements, you opened a browser, took screenshots, and visually confirmed (see task.mdc → Visual Verification Gate).
3. User Verification Gate — The user has either tested and confirmed, OR explicitly waived testing.

If the user has not yet responded to the verification prompt, you may NOT:

• Edit any file in docs/
• Edit any file in docs/task/logs/
• Edit any file in docs/agent-observations/
• Stage, commit, or push any changes

Scenario Evidence Requirement (BLOCKING): Documentation is blocked until all required behavior-path scenarios were executed end-to-end.

Untested Disclosure Requirement (BLOCKING): The verification summary must include an explicit Not Tested section listing every unexecuted check/scenario (or Not Tested: none).

CRITICAL — NO SKIPPING: You are never permitted to bypass this timing gate on your own judgment.

Update "Last updated" Date on Every Doc Edit

Whenever you edit any markdown file in docs/, you MUST also update its > **Last updated:** YYYY-MM-DD line (or <!-- Updated: YYYY-MM-DD --> comment) to today's date.