# Documentation Index

Quick reference to all documentation in this repository.

## Getting Started

| Document | Purpose |
|----------|---------|
| [README.md](README.md) | Project overview, installation, quick start |
| [CONTRIBUTING.md](CONTRIBUTING.md) | How to contribute to this project |
| [LICENSE](LICENSE) | Apache-2.0 license terms |

## Agent Integration

| Document | Purpose |
|----------|---------|
| [AGENTS.md](AGENTS.md) | Agent skills specification for AI coding agents |
| [CLAUDE.md](CLAUDE.md) | Claude Code project context |
| [GEMINI.md](GEMINI.md) | Gemini CLI integration |

## Skills Reference

All skills follow the Agent Skills specification format.

| Skill | What it teaches |
|-------|-----------------|
| [convex-best-practices](skills/convex-best-practices/SKILL.md) | Production patterns, error handling, OCC |
| [convex-functions](skills/convex-functions/SKILL.md) | Queries, mutations, actions, HTTP actions |
| [convex-realtime](skills/convex-realtime/SKILL.md) | Subscriptions, optimistic updates |
| [convex-schema-validator](skills/convex-schema-validator/SKILL.md) | Schema definition, typing, validation |
| [convex-file-storage](skills/convex-file-storage/SKILL.md) | Upload, storage, serving files |
| [convex-agents](skills/convex-agents/SKILL.md) | AI agents with thread management |
| [convex-cron-jobs](skills/convex-cron-jobs/SKILL.md) | Scheduled functions, background tasks |
| [convex-http-actions](skills/convex-http-actions/SKILL.md) | HTTP endpoints, webhooks |
| [convex-migrations](skills/convex-migrations/SKILL.md) | Schema evolution, data migrations |
| [convex-security-check](skills/convex-security-check/SKILL.md) | Quick security audit checklist |
| [convex-security-audit](skills/convex-security-audit/SKILL.md) | Deep security review patterns |
| [convex-component-authoring](skills/convex-component-authoring/SKILL.md) | Reusable Convex components |

## Templates

Templates for developers to copy when starting new projects or forking.

| Template | Purpose |
|----------|---------|
| [templates/CLAUDE.md](templates/CLAUDE.md) | Project context template for Convex projects |
| [templates/skills/](templates/skills/) | Claude Code skills templates |

### Skill Templates

| Template | Purpose |
|----------|---------|
| [templates/skills/dev.md](templates/skills/dev.md) | Full-stack development practices |
| [templates/skills/help.md](templates/skills/help.md) | Problem-solving methodology |
| [templates/skills/gitrules.md](templates/skills/gitrules.md) | Git safety protocols |

## Project Tracking

| Document | Purpose |
|----------|---------|
| [changelog.md](changelog.md) | Version history |
| [files.md](files.md) | Codebase structure reference |
| [task.md](task.md) | Completed task tracking |

## Planning Documents

Located in `prds/` directory.

| Document | Purpose |
|----------|---------|
| [skillsplan.md](prds/skillsplan.md) | Skills development roadmap |
| [future-skills-exploration.md](prds/future-skills-exploration.md) | Future skills ideas |
| [CLAUDE-MD-STRATEGY.md](prds/CLAUDE-MD-STRATEGY.md) | CLAUDE.md template strategy |

## External References

| Resource | URL |
|----------|-----|
| Convex Documentation | https://docs.convex.dev/ |
| Convex LLMs.txt | https://docs.convex.dev/llms.txt |
| Convex Best Practices | https://docs.convex.dev/understanding/best-practices/ |
| Agent Skills Spec | https://github.com/anthropics/skills |