doc-scanner
- Repo stars 0
- Author repo skills-registry
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
<!-- tomevault:4.0:skill_md:2026-05-23 -->Source: ComeOnOliver/skillshub — distributed by TomeVault.
- Fluxly category
- Documentation
- Author-declared agents
- No explicit declaration found; this is not inferred or tested compatibility
- Static check
- 88 / 100 · heuristic scan, not runtime safety proof
- Author / version / license
- @tomevault-io · no license declared
- Fluxly token estimate
- Lean
- Fluxly setup estimate
- Plug-and-play
- External API key
- No requirement detected
- Detected OS requirements
- Unspecified
- Runtime requirements
- Unspecified
- Detected file/system behavior
-
- Read-only
- Write / modify
- Detected network behavior
- Local-only
- Install commands
- None (reference only)
Profile is derived at build time from SKILL.md and install vectors. Subject to drift from author intent.
Heads up: 未限定 allowed-tools,默认拥有全部工具权限。
The current SKILL.md does not define a fixed output example. Use Glob to search project root:
Read complete contents of every documentation file found.
Combine information into unified summary:
If 2+ documentation files exist, offer to consolidate: Create .doc-archive/ directory Archive originals with date suffix
If none found, offer to generate AGENTS.md based on: Project structure and tech stack Patterns observed in codebase
# 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:
1. Create `.doc-archive/` directory
2. Archive originals with date suffix
3. Generate unified AGENTS.md
4. 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
1. AGENTS.md (platform-agnostic)
2. CLAUDE.md (Claude-specific)
3. Other AI docs
4. IDE docs
5. 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
---
… Author text anchors workflow facts; Fluxly only indexes current sections, terms, files, and commands.
sections -> When to Activate → Instructions → Step 1: Scan for Documentation → Step 2: Read All Found Files → Step 3: Synthesize → Step 4: Offer Consolidation
terms -> Scan for and synthesize project documentation. · Read complete contents of every documentation file found. · 1. Create .doc-archive/ directory 2. · 1. AGENTS.md (platform-agnostic) 2. · --- > Source: [ComeOnOliver/skillshub](https://github.com/ComeOnOliver/skillshub) — distributed by [TomeVault](https://tomevault.io).
files/cmd -> .doc-archive/ · ./references/file-patterns.md · ./references/templates.md · new/unfamiliar · AGENTS.md · CLAUDE.md · AI.md · ASSISTANT.md
body sha256 -> 649877bc0b5a
Decide Fit First
Design Intent
How To Use It
Boundaries And Review