- Add .architect/ directory structure (10 template files) as project brain for agent orientation - Add architect-indexer agent that scans codebase and generates structured architecture docs - Add Docker containerization: Dockerfile.architect-indexer, docker-compose.architect.yml - Add TypeScript project-mapper module with staleness detection and context injection - Add /index-project command, architect-first-contact rule, project-mapping skill - Integrate orchestrator first-contact check: triggers indexing before any task delegation - Add npm arch:* scripts for Docker-based indexing workflow - Register agent in capability-index.yaml and AGENTS.md
📐 Project Architecture Index
Auto-generated navigation file. Updated by
architect-indexeron every pipeline run. DO NOT edit manually — changes will be overwritten. Edit source code instead.
Quick Status
| Metric | Value |
|---|---|
| Last Indexed | pending first run |
| Index Version | 1 |
| Files Tracked | 0 |
| Modules | 0 |
| Staleness | unknown |
Navigation
🏗 Architecture
| File | Description | When to Read |
|---|---|---|
architecture/overview.md |
High-level project architecture, layers, boundaries | Before ANY implementation task |
architecture/dependency-graph.md |
Module-to-module dependency graph | Before adding cross-module imports |
📦 Entities & Data
| File | Description | When to Read |
|---|---|---|
entities/entities.md |
All domain entities, their fields and relationships | Before creating/editing models or DB tables |
db-schema/schema.md |
Database tables, columns, indexes, foreign keys, migrations | Before touching any migration or DB query |
🌐 API Surface
| File | Description | When to Read |
|---|---|---|
api-surface/endpoints.md |
All API endpoints, methods, auth, request/response types | Before adding/modifying any API endpoint |
📏 Conventions
| File | Description | When to Read |
|---|---|---|
conventions/conventions.md |
Coding style, naming, patterns, forbidden practices | Before writing ANY code |
🔧 Tech Stack
| File | Description | When to Read |
|---|---|---|
tech-stack/stack.md |
Languages, frameworks, libraries, versions | Before adding dependencies or choosing tools |
🗺 Machine-Readable Maps
| File | Description | Used By |
|---|---|---|
maps/file-graph.json |
File → imports/exports graph | architect-indexer, system-analyst, lead-developer |
maps/module-graph.json |
Module → dependencies graph | system-analyst, orchestrator for routing |
⚙️ Machine Config
| File | Description | Used By |
|---|---|---|
project.json |
Project metadata (name, type, framework, entry points) | orchestrator for routing decisions |
state.json |
Index freshness state (hashes, timestamps, version) | orchestrator to detect staleness |
How It Works
For Agents
- First contact: Orchestrator checks
.architect/state.json - Stale or missing: Launch
architect-indexerto build/update - Fresh: Read relevant files from
.architect/for context - After changes:
architect-indexerincrementally updates affected sections
For Humans
- Browse any
.mdfile for human-readable documentation - Check
project.jsonfor quick project facts - See
state.jsonfor when the index was last updated
Update Triggers
| Event | Action |
|---|---|
| New file added/removed | Rebuild maps/file-graph.json |
| New dependency added | Update tech-stack/stack.md |
| Schema migration created | Update db-schema/schema.md |
| New entity/model created | Update entities/entities.md |
| New API endpoint added | Update api-surface/endpoints.md |
| Convention file changed | Update conventions/conventions.md |
| Any structural change | Increment version in state.json |