/gaia-document-project
user-facingWhat it does
/gaia-document-project scans an existing project's filesystem, detects its technology stack, maps its directory structure, and produces a comprehensive project-documentation.md artifact optimized for onboarding humans and AI agents.
When to use it
- You want to document an existing project for team onboarding.
- You want to generate a project overview for AI agents to understand your codebase.
Prerequisites
- No prerequisites. Works on any project with source files.
How to invoke
/gaia-document-projectWhat it does step by step
- Scan project Discovers source files, config files, and existing documentation using Glob patterns (capped at 500 files per pattern).
- Detect technology Reads manifest files (package.json, pubspec.yaml, etc.) to identify languages, frameworks, dependencies, and test frameworks.
- Map structure Produces a directory overview focused on the top-level layout with entry point detection from manifest fields.
- Generate artifact Writes the project documentation to
.gaia/artifacts/planning-artifacts/project-documentation.md.
Inputs
| Input | Source | Description |
|---|
Outputs
| Output | Location | Description |
|---|---|---|
| Project documentation | .gaia/artifacts/planning-artifacts/project-documentation.md | Comprehensive project overview with stack, structure, and conventions. |
Example session
> /gaia-document-project
Scanning project...
156 source files across 12 directories.
4 config files, 1 package manifest.
Technology detected:
Language: TypeScript
Framework: Express.js
Test: Jest
Written to .gaia/artifacts/planning-artifacts/project-documentation.mdWhat to run next
/gaia-project-context-- generate a compact AI-optimized context file.
Troubleshooting
No source files detected
The project directory is empty or all files matched the exclusion list. An empty documentation artifact is still created.
Scan truncated at 500 files
Large projects cap scanning to protect performance. Results may be incomplete.