review

Verify markdown notes for description quality, schema compliance, and link health.

20|5|Updated Nov 18, 2025
One-click install
npx skills add https://github.com/zby/llm-do --skill review-zby
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: review
Source: https://github.com/zby/llm-do/tree/main/arscontexta/skills/arscontexta-review
Command: npx skills add https://github.com/zby/llm-do --skill review-zby

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the comprehensive verification of notes, ensuring they meet quality standards for description accuracy, schema compliance, and internal linking, preventing the accumulation of low-quality or broken documentation.

Core Features & Use Cases

  • Recite (Cold-Read Prediction): Tests if the note's title and description alone accurately predict its content, ensuring clear and informative metadata.
  • Validate (Schema Compliance): Checks if the note adheres to predefined templates, verifying required fields, valid enum values, and correct formatting.
  • Review (Health Checks): Performs essential checks like frontmatter integrity, index connection, and link resolution to maintain the knowledge graph's health.
  • Use Case: After creating a new note on a complex technical topic, run /review to automatically check if its description is clear enough for an AI to understand, if it follows the correct documentation schema, and if all its internal links point to valid existing notes.

Quick Start

Run a full review of the note titled 'example-note'.

Frequently Asked Questions about review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I verify the quality and integrity of markdown notes?

To verify markdown notes, you can automate checks for description accuracy via cold-read prediction, validate schema compliance against predefined templates, and perform health checks for link resolution and index integration.

How does cold-read prediction test if a note's metadata is clear enough?

Cold-read prediction tests if a note's title and description alone accurately predict its content. This mechanism ensures your metadata remains clear and informative for both AI and human readers to understand.

What is the best way to validate schema compliance and check for broken links in documentation?

The best way is to run an automated health check that validates required fields and enum values against templates, verifies frontmatter integrity, and resolves internal links to maintain your knowledge graph's health.

Can I trigger documentation verification on specific note targets or commands?

Yes, you can trigger the verification process on specific note targets or commands. The review process supports configurable processing depth to thoroughly assess targeted markdown files.

Why does note verification prevent the accumulation of low-quality documentation?

Note verification prevents low-quality documentation by automating multi-faceted checks that ensure description accuracy, strict schema compliance, and valid internal linking before notes are integrated into your knowledge base.