# Module Docs

> Generate per-module documentation by tracing references from module anchors. Use when indexing project modules for fast AI lookup.

- Skill: `oaa-dev/module-docs` (Agent Skill, multi-file: 3 files)
- Install (CLI): `npx skillmds@latest add oaa-dev/module-docs`
- Raw SKILL.md: https://api.skillmd.com/api/skills/oaa-dev/module-docs/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: oaa-dev (https://skillmd.com/u/oaa-dev)
- Updated: 2026-09-22
- Page: https://skillmd.com/skills/oaa-dev/module-docs

---


# Module Docs Generator

**Purpose:** Auto-index project modules into markdown files in `docs/knowledge/modules/` for fast AI navigation. Uses a reference-tracing approach that works regardless of project directory conventions.

## Overview

Instead of enumerating file types, this skill starts from **module anchors** (models for Laravel, route segments for Next.js) and traces all references to build a complete picture of each module.

**Key principle:** Grep the project for the anchor's class/name, then categorize what you find. This naturally discovers any file type -- including custom ones the project may use.

---

## Process

### Step 1: Detect Stack

Read `knowledge-garden.local.md` or `docs/knowledge/schema.yaml` to determine the stack. If neither exists, run the setup skill first.

### Step 2: Discover Module Anchors

**Laravel:** Scan `app/Models/` for model files. Each model = one module.

**Next.js:** Detect router type (`app/` or `pages/`). Each top-level route segment = one module.

If `$ARGUMENTS` specifies a module name, process only that module. Otherwise process all discovered modules.

### Step 3: Generate Module Docs

For each module anchor, follow the stack-specific scanning strategy:

- **Laravel**: Follow the strategy in [laravel-scan.md](./references/laravel-scan.md)
- **Next.js**: Follow the strategy in [nextjs-scan.md](./references/nextjs-scan.md)

### Step 4: Write Module Files

Write each module doc to `docs/knowledge/modules/{module-name}.md` (lowercase, hyphenated).

### Step 5: Summary

After processing all modules, present a summary:

```
Module docs generated:

| Module | Files Found | Path |
|--------|-------------|------|
| User | 14 | docs/knowledge/modules/user.md |
| Order | 22 | docs/knowledge/modules/order.md |
| ... | ... | ... |

Total: [N] modules indexed, [N] connected files discovered.
```

---

## Incremental Updates

If module docs already exist in `docs/knowledge/modules/`, re-running this skill will overwrite them with fresh scans. The skill does not attempt to merge -- a full rescan is fast enough and avoids stale data.

---

## Error Handling

**No models/routes found:**
- Report: "No module anchors found. Ensure your project has models in app/Models/ (Laravel) or route segments in app/ or pages/ (Next.js)."

**Schema not found:**
- Suggest running setup first: "Run /setup to initialize knowledge-garden before generating module docs."