Documentation & refactoring · Improve

Improve Documentation Sync

Implement one selected, evidence-backed Documentation Sync improvement at the authoritative owner. Complete the directly affected contract without broad cleanup or redesign.

Vibe Coding 1.3.0 · vibe-docs · English technical instructions

← Back to search

Use this workflow

Use this workflow in Codex or Claude Code with the free Vibe Coding plugin. Choose your assistant and prompt language, then add your task details after the prompt.

Operation

Implement the requested coherent change at the owning source and update directly affected consumers. An earlier audit is optional when the user and repository already establish the target. Validate the changed behavior, then stop when the requested scope is complete.

Goal

Implement one selected, evidence-backed Documentation Sync improvement at the authoritative owner. Complete the directly affected contract without broad cleanup or redesign.

Domain rules

  • Update the nearest maintained document or generator source, not downstream generated output alone.
  • Keep examples executable/minimal and avoid inventing commands, flags, fields, or environment guarantees.
  • Record version/environment assumptions and distinguish repository-proven behavior from external requirements.
  • Remove stale duplicate guidance when one canonical document now owns it.

Validation

  • Run doc generators, link/lint/example/command checks available in the repository.
  • Compare generated diff and verify referenced paths/symbols/configs exist.
  • List external service or deployment behavior not executable from the worktree.

Workflow ID: documentation-sync-polish · View the versioned source · Shared workflow and authority rules