Guides

Repair documentation drift

Align public docs, examples, commands, and configuration references with the product that actually ships.

Answers: use a coding agent to fix documentation drift · Updated

SHORT ANSWER

A documentation-drift shift compares the shipped interface with every authoritative explanation, fixes contradictions at their source, and verifies commands and links instead of merely polishing prose.

01

Find authoritative truth

Start from manifests, command definitions, schemas, tests, and released behavior. Documentation should explain those facts in user language without inventing support.

  • Install commands and supported hosts
  • Configuration names and defaults
  • Workflow steps and stop behavior
  • Examples and expected output
  • Platform and recovery limits
02

Repair the information path

Update the narrowest authoritative page, then follow internal links and duplicated snippets that could keep the old claim alive.

  • Prefer one canonical explanation.
  • Use redirects or compatibility notes for renamed paths.
  • Remove stale screenshots only when their meaning changed.
03

Verify like code

Run link, command, schema, or workspace-doc checks when the repository provides them. A readable sentence is not enough if the command is wrong.

TRY IT

Start with a bounded prompt

This prompt names the outcome and preserves Nightshift’s review boundary. Paste it into the supported coding host from the project you want to change.

Run a documentation-drift shift against this repository. Verify local links, commands, filenames, examples, and version claims against the files that ship.
BOUNDARIES

What this workflow does not claim

  • Third-party URLs that cannot be verified locally are recorded as skipped, not declared correct.
  • The shift repairs documentation drift; it does not invent product behavior to make a claim true.
SOURCES

Evidence and sources

These links support the released behavior, public outcomes, or problem language described on this page.

documentation-drift contractThe released local documentation-verification contract.Open evidence ↗Versioned command referenceThe shipped skills, natural-language Codex equivalents, and offline helpers.Open evidence ↗Versioned workflow contractThe shipped one-item loop, decision boundary, gates, recovery, and clock-out behavior.Open evidence ↗
RELATED QUESTIONS

Continue from the question you have

check README commands against repository codeRead the answer →clean repository maintenance workRead the answer →import selected GitHub issuesRead the answer →