maintain-docs

Maintain VidXP documentation

Keep VidXP documentation accurate, appropriately placed, and readable without requiring the reader to know the implementation first.

Load the project context

1. Read the applicable AGENTS.md instructions and docs/CONTRIBUTING.md.

2. Read references/documentation-map.md to identify the document owner and audience.

3. Read references/writing-standard.md before creating, rewriting, or reviewing human-facing prose.

4. Inspect git status and the relevant diff. Preserve unrelated work and do not stage or commit changes unless the user asks.

5. Run the established Markdown checks before editing to record the baseline:

   npx --yes [email protected]
   lychee "**/*.md" ".github/**/*.md" ".agents/**/*.md"
   

   If Lychee is unavailable locally, use the pinned container command in docs/CONTRIBUTING.md or report that the link check was not run. Record the baseline instead of attributing pre-existing findings to the current change.

Maintain the documentation

1. Define the change

• Identify the behavior, decision, workflow, or correction being documented.
• Determine whether the task concerns one document, the current diff, or a wider documentation audit.
• Identify every affected surface: end user, integrator, operator, contributor, maintainer, researcher, or agent.

Do not treat an audience label as proof that prose is suitable for that audience. Evaluate the document's vocabulary, sequence, assumptions, and level of detail.

2. Choose the owner

• Update the smallest document that owns the information.
• Link to the canonical explanation instead of copying it into several files.
• Use tutorial, how-to, reference, and explanation as reader-need categories, not as a mandatory directory structure.
• Keep human contributor guidance separate from agent instructions.
• Keep repository-maintenance guidance separate from the product-distributed skills under plugins/vidxp/skills/.
• Do not create a documentation changelog, decision log, incident report, or new directory taxonomy unless the repository has adopted it or the user asks.