# Contextuate

<!--
  CONTEXTUATE MANAGED FILE - DO NOT MODIFY
  This file is generated by the Contextuate Framework and will be overwritten during updates.
  Customize your project context in: docs/ai/context.md
-->

> **Purpose:** Master entry point for AI assistants. This file bootstraps the Contextuate Framework.
> **Directive:** Read this file first, then follow instructions to load project context.

---

## 1. Project Context

**Read the project-specific context file for details about this project:**

[Project Context](../context.md)

> If `context.md` exists, it contains project identity, tech stack, and custom configurations.

## Framework Usage Guide

This folder (`docs/ai/.contextuate/`) contains the immutable framework definitions. You should use references to these files to "pull in" capabilities only when needed, maintaining token efficiency.

**Do not read all files in this directory at once.**

1.  **Discover**: Read this file (`contextuate.md`) to map the available resources.
2.  **Select**: Identify the specific agent, tool, or standard relevant to your current task.
3.  **Load**: Read only that specific file.

For example, if you need to create a new agent, read `docs/ai/.contextuate/tools/agent-creator.md`. You do not need to read the entire standards library unless you are writing code that specifically requires it.

---

## 2. Agent Framework

> **Rule:** If a specialized agent exists for your task, you MUST adopt that persona and read its specific context.

### Agent Registry
| Task Domain    | Agent        | Context File                                                                             |
| -------------- | ------------ | ---------------------------------------------------------------------------------------- |
| General Coding | Base Agent   | [agents/base.md](agents/base.md)                               |
| Documentation  | Docs Expert  | [agents/documentation-expert.md](agents/documentation-expert.md) |
| Tools Expert   | Tools Expert | [agents/tools-expert.md](agents/tools-expert.md)               |

### Custom Agents
Custom agents are stored in `docs/ai/agents/`. Create new agents using the Agent Creator tool.

---

## 3. Tooling Ecosystem

### Framework Tools
| Tool                   | Purpose                       | Instruction Guide                                                                              |
| ---------------------- | ----------------------------- | ---------------------------------------------------------------------------------------------- |
| **Standards Detector** | Analyze code to find patterns | [tools/standards-detector.md](tools/standards-detector.md) |
| **Quickref Generator** | Condense docs for AI usage    | [tools/quickref.md](tools/quickref.md)                     |
| **Agent Creator**      | Generate new agent personas   | [tools/agent-creator.md](tools/agent-creator.md)           |

---

## 4. Standards & Conventions

### Framework Standards
| Standard | Purpose | File |
|----------|---------|------|
| **Coding Standards** | General coding principles | [standards/coding-standards.md](standards/coding-standards.md) |
| **Behavioral Guidelines** | AI interaction rules | [standards/behavioral-guidelines.md](standards/behavioral-guidelines.md) |
| **Task Workflow** | Multi-session task structure | [standards/task-workflow.md](standards/task-workflow.md) |
| **Agent Workflow** | Multi-agent coordination | [standards/agent-workflow.md](standards/agent-workflow.md) |
| **Agent Roles** | Specialist agent roster | [standards/agent-roles.md](standards/agent-roles.md) |

### Project-Specific Standards
Create language-specific standards in `docs/ai/standards/` using the [Standards Detector](tools/standards-detector.md) tool.

---

## 5. Documentation Strategy

> **Rule:** Store knowledge where it belongs. Do not rely on chat history.

| Content Type            | Location             |
| ----------------------- | -------------------- |
| **AI Context**          | `docs/ai/`           |
| **Custom Agents**       | `docs/ai/agents/`    |
| **Custom Standards**    | `docs/ai/standards/` |
| **Quick References**    | `docs/ai/quickrefs/` |
| **Multi-Session Tasks** | `docs/ai/tasks/`     |
| **Custom Commands**     | `docs/ai/commands/`  |

### Multi-Session Tasks
For complex tasks that span multiple sessions, follow the Task Workflow standard (see section 4).

---

## 6. Framework Information

**Contextuate Framework** is a standardized AI context framework.

- **Documentation:** https://contextuate.md
- **Version:** Check `.contextuate/version.json`
