gaia-document-project

Scan a repository, detect the tech stack, and generate project-documentation.md.

2|Updated Apr 15, 2026
One-click install
npx skills add https://github.com/gaiastudio-ai/gaia-public --skill gaia-document-project
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: gaia-document-project
Source: https://github.com/gaiastudio-ai/gaia-public/tree/main/plugins/gaia/skills/gaia-document-project
Command: npx skills add https://github.com/gaiastudio-ai/gaia-public --skill gaia-document-project

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Documenting a software project for AI context is time consuming and error prone; this skill automates the process by scanning a repository, detecting the tech stack, and mapping the directory structure to produce a comprehensive project-documentation.md artifact that supports onboarding and AI reasoning.

Core Features & Use Cases

  • Scan the repository to inventory source files and directory structure.
  • Detect the tech stack from canonical manifests (e.g., package.json, pom.xml, go.mod) and extract dependencies and environment information.
  • Generate a structured project-documentation.md under docs/planning-artifacts/ that serves as a single source of truth for developers and AI agents.
  • Use case: onboarding new team members or enabling AI assistants to understand project layout and dependencies.

Quick Start

Run the gaia-document-project skill on the repository to generate docs/planning-artifacts/project-documentation.md.

Frequently Asked Questions about gaia-document-project

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

FAQPage Schema
How do I generate project documentation for AI context automatically?

To generate project documentation for AI context, you can run a skill that scans your repository, detects the tech stack from manifests, and outputs a structured project-documentation.md file. This provides a single source of truth for AI reasoning and onboarding.

What is the best way to document a codebase for new team members?

The best way to document a codebase for onboarding is to automate repository scanning to inventory source files and directory structures, then generate a comprehensive markdown artifact. This maps dependencies and the tech stack into a single source of truth.

Does this project documentation tool work with different tech stacks?

Yes, this project documentation tool works with diverse codebases by detecting the tech stack from canonical manifests like package.json, pom.xml, or go.mod. It extracts dependencies and environment information to support various frameworks.

How do I create a single source of truth for my repository structure and dependencies?

You create a single source of truth for repository structure by scanning source files and mapping the directory layout into a project-documentation.md artifact. This deterministic file scan excludes irrelevant paths and records all dependencies.

Where does the generated project documentation artifact get saved?

The generated project documentation artifact is saved under the docs/planning-artifacts/ directory as project-documentation.md. This specific path ensures the documentation is consistently placed for governance and AI provisioning.

Can I exclude irrelevant files when scanning my codebase for documentation?

Yes, you can exclude irrelevant files when scanning your codebase for documentation. The skill implements deterministic file scanning that automatically excludes irrelevant paths to ensure the generated artifact only contains meaningful project structure data.