docs-list

List markdown files in the docs directory and summarize their frontmatter.

5|Updated Oct 22, 2025
One-click install
npx skills add https://github.com/marchatton/agent-skills --skill docs-list
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-list
Source: https://github.com/marchatton/agent-skills/tree/main/.agents/skills/00-utilities/docs-list
Command: npx skills add https://github.com/marchatton/agent-skills --skill docs-list

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill helps you ensure your project's documentation is comprehensive and up-to-date by listing all markdown files in the docs/ directory and their summaries.

Core Features & Use Cases

  • Documentation Auditing: Quickly see which documents are covered and which might be missing.
  • Frontmatter Validation: Checks for required summary: and optional read_when: fields in your markdown files.
  • Use Case: Before a release, run this Skill to verify that all feature documentation has a clear summary and any specific reading conditions are noted.

Quick Start

Run the docs-list skill to list all markdown files in the docs directory and their summaries.

Frequently Asked Questions about docs-list

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

FAQPage Schema
How do I audit markdown documentation coverage in my project?

To audit documentation coverage, list all markdown files in your docs directory and check their frontmatter for required summary fields. This identifies missing or stale documentation before project releases.

What frontmatter fields are required for complete documentation auditing?

Documentation auditing requires the summary field in markdown frontmatter and supports the optional read_when field to note specific reading conditions. Missing or stale fields indicate incomplete coverage.

Can I check for missing or stale documentation before a release?

Yes, you can check for missing or stale documentation before a release by listing markdown files and validating their frontmatter content. This verifies all features have clear summaries and reading conditions noted.

How do I list all markdown files and their summaries in the docs directory?

List markdown files in the docs directory by running an audit that summarizes their frontmatter content. This provides a quick overview of which documents are covered and which might be missing.

What is the best way to ensure documentation completeness across markdown files?

The best way to ensure documentation completeness is to validate frontmatter fields like summary and read_when across all markdown files. This audit identifies gaps and ensures content is comprehensive and up-to-date.