Review Docs

Review Video.js documentation without editing it. Use for accuracy, reader outcomes, structure, voice, examples, MDX, READMEs, or docs diffs.

videojs 349cb94 1.3 KB Updated

File contents

Documentation review

Treat implementation, types, tests, schemas, and generated output as factual sources.

  1. Identify the audience, intended outcome, artifact type, and owning source files.
  2. For site guides and concepts, read site/src/content/docs/how-to/write-guides.mdx. For generated reference pages, read site/src/content/docs/reference/write-references.mdx. Use neighboring docs for other artifact types.
  3. Verify claims and examples against current code before reviewing voice, structure, examples, MDX conventions, and reader outcomes against the owning guide.
  4. When content seems to mix document types — steps in a concept, teaching or opinion in a reference — check it against .agents/skills/write-docs/references/diataxis.md.
  5. Render affected MDX and run examples where practical.

Report broken or misleading content first. For each finding, give the location, reader impact, evidence, and concise fix. Keep stylistic preferences separate from correctness issues.

Example

Input: “Review the new autoplay guide.”

Output: Accuracy and reader-outcome findings first, followed by clearly separated structure or voice suggestions.

videojs/v10/tree/main/.agents/skills/review-docs commit 349cb94abf

Frequently asked questions

npx skillmds@latest add videojs/review-docs