What happens if no documentation is found?

The scanner offers to generate a platform-agnostic AGENTS.md based on the project structure, tech stack, and observed patterns.

Can I consolidate docs from multiple platforms?

Yes. The tool can consolidate into a unified AGENTS.md, create a .doc-archive/ directory, archive originals with a date suffix, and report what was consolidated.

What is the priority order for docs?

Priority: AGENTS.md (platform-agnostic), then CLAUDE.md, then other AI docs, followed by IDE docs and Terminal docs per the Priority Order.

doc-scanner

Scanned

npx machina-cli add skill aiskillstore/marketplace/doc-scanner --openclaw

Files (1)

SKILL.md

2.1 KB

Documentation Scanner

Scan for and synthesize project documentation.

When to Activate

User asks to review, understand, or explore a codebase
Starting work in a new/unfamiliar project
User asks about project conventions or workflows
Before making significant architectural decisions

Instructions

Step 1: Scan for Documentation

Use Glob to search project root:

AGENTS.md, CLAUDE.md, AI.md, ASSISTANT.md,
GEMINI.md, COPILOT.md, CHATGPT.md, CODEIUM.md,
CURSOR.md, WINDSURF.md, VSCODE.md, JETBRAINS.md,
WARP.md, FIG.md, DEVCONTAINER.md, GITPOD.md

Step 2: Read All Found Files

Read complete contents of every documentation file found.

Step 3: Synthesize

Combine information into unified summary:

PROJECT DOCUMENTATION

Sources: [list files found]

RECOMMENDED AGENTS
  Primary: [agents for core work]
  Secondary: [agents for specific tasks]

KEY WORKFLOWS
  [consolidated workflows]

CONVENTIONS
  [code style, patterns]

QUICK COMMANDS
  [common commands]

Step 4: Offer Consolidation

If 2+ documentation files exist, offer to consolidate:

Create .doc-archive/ directory
Archive originals with date suffix
Generate unified AGENTS.md
Report what was consolidated

Step 5: No Documentation Found

If none found, offer to generate AGENTS.md based on:

Project structure and tech stack
Patterns observed in codebase

Priority Order

AGENTS.md (platform-agnostic)
CLAUDE.md (Claude-specific)
Other AI docs
IDE docs
Terminal docs

Additional Resources

For detailed patterns, load:

./references/file-patterns.md - Complete list of files to scan
./references/templates.md - AGENTS.md generation templates

Source

git clone https://github.com/aiskillstore/marketplace/blob/main/skills/0xdarkmatter/doc-scanner/SKILL.mdView on GitHub

Overview

Scans for and synthesizes project documentation across formats (AGENTS.md, CLAUDE.md, GEMINI.md, COPILOT.md, CURSOR.md, WARP.md, and 15+ others) into a unified guidance set. It auto-activates when you want to review a codebase, start a new project, or explore conventions or agents, and can consolidate multiple platform docs into a single AGENTS.md for consistency and onboarding.

How This Skill Works

Steps: 1) Glob-search the project root for documented files such as AGENTS.md, CLAUDE.md, AI.md, ASSISTANT.md, GEMINI.md, COPILOT.md, CURSOR.md, WARP.md, and others. 2) Read all found files, then synthesize a unified summary with sources, recommended agents, workflows, conventions, and quick commands. 3) If 2+ docs exist, offer consolidation by creating a .doc-archive/ directory, archiving originals with a date suffix, generating a unified AGENTS.md, and reporting what was consolidated; if none are found, generate AGENTS.md based on project structure and observed patterns.

When to Use It

Review or explore a codebase by generating a synthesized documentation briefing
Start work in a new or unfamiliar project to establish conventions
Ask about project conventions, agent roles, or recommended workflows
Before making significant architectural decisions to align with docs
When documentation context would help onboarding or decision making

Quick Start

Step 1: Run doc-scanner at the project root to scan for documented files (AGENTS.md, CLAUDE.md, AI.md, ASSISTANT.md, GEMINI.md, COPILOT.md, CHATGPT.md, CODEIUM.md, CURSOR.md, WINDSURF.md, VSCODE.md, JETBRAINS.md, WARP.md, FIG.md, DEVCONTAINER.md, GITPOD.md)
Step 2: Read the found documents and let the scanner synthesize a unified summary with sources and recommended agents
Step 3: If multiple docs exist, opt to consolidate into AGENTS.md, review the generated report, and optionally archive originals in .doc-archive/ with a date suffix

Best Practices

Use a comprehensive scan list to avoid missing essential files (AGENTS.md, CLAUDE.md, GEMINI.md, COPILOT.md, CURSOR.md, WARP.md, and 15+ others)
Validate sources before consolidation; preserve originals and note changes
Prioritize generating a platform-agnostic AGENTS.md first, then specialized docs
When consolidating, create .doc-archive/ and suffix filenames with date
Keep SOURCES and RECOMMENDED AGENTS sections updated with new docs or patterns

Example Use Cases

A codebase with AGENTS.md, CLAUDE.md, and GEMINI.md yields a unified AGENTS.md for onboarding
Consolidation creates a single authoritative doc and archives originals
No docs found; the scanner generates AGENTS.md from observed structure and tech stack
Before a major refactor, the tool proposes recommended workflows and agent roles
New engineer uses the synthesized AGENTS.md to understand project conventions quickly

Frequently Asked Questions

Add this skill to your agents