# Documentation Index

> Central navigation hub for all persuade documentation

## Quick Links

| If you need to... | Read this |
|-------------------|-----------|
| Get started quickly | [Quick Start](../QUICKSTART.md) |
| Install Claude Code | [Installing Claude Code](./installing-claude-code.md) |
| Sync automation to a project | [Syncing Automation](./syncing-automation.md) |
| Understand the CLI | [Persuade CLI](../persuade/README.md) |
| Learn engineering standards | [Engineering Standards](../.claude/standards/ENGINEERING_STANDARDS.md) |
| Follow critical rules | [Claude Code Rules](../.claude/standards/CLAUDE_CODE_RULES.md) |

---

## Documentation by Category

### Getting Started

- [**Quick Start Guide**](../QUICKSTART.md) - Get up and running fast
- [**Installing Claude Code**](./installing-claude-code.md) - Platform-specific installation
- [**Using Claude Template**](./using-claude-template.md) - Project configuration guide
- [**Syncing Automation**](./syncing-automation.md) - Distribute to your projects

### User Guides

- [**Claude Code Best Practices**](./claude-code-best-practices.md) - Optimize your workflow
- [**Prompt Engineering Guide**](./prompt-engineering-guide.md) - Master effective prompting
- [**Contributing Guide**](../CONTRIBUTING.md) - How to contribute

### Technical Documentation

- [**Persuade CLI**](../persuade/README.md) - Full CLI documentation
- [**Automation System**](../.claude/README.md) - How the automation works
- [**GitHub Workflows**](../.github/workflows/README.md) - CI/CD automation

### Standards & Rules

- [**Engineering Standards**](../.claude/standards/ENGINEERING_STANDARDS.md) - Comprehensive coding standards
- [**Claude Code Rules**](../.claude/standards/CLAUDE_CODE_RULES.md) - Non-negotiable requirements
- [**Virtual Environment Setup**](../.claude/standards/VIRTUAL_ENVIRONMENT_SETUP.md) - Python venv guide
- [**Settings Guide**](../.claude/standards/SETTINGS_GUIDE.md) - Configuration reference

### Knowledge Base

The `.claude/knowledge/` directory contains tactical how-to guides:

- [**Knowledge Base Index**](../.claude/knowledge/README.md) - Full index
- [**Git Guides**](../.claude/knowledge/git/) - PR workflow, commits, messages
- [**Python Guides**](../.claude/knowledge/python/) - Venv, type hints
- [**Testing Guides**](../.claude/knowledge/testing/) - Pytest, test structure
- [**Automation Guides**](../.claude/knowledge/automation/) - PR iteration, sync tool
- [**Infrastructure Guides**](../.claude/knowledge/infrastructure/) - IaC, cost management
- [**PR Feedback Rules**](../.claude/knowledge/pr-feedback/) - Structured feedback guidelines

---

## Documentation for Different Audiences

### For Developers

Start here:
1. [Quick Start](../QUICKSTART.md)
2. [Claude Code Best Practices](./claude-code-best-practices.md)
3. [Syncing Automation](./syncing-automation.md)

### For AI Assistants

Read in order:
1. [Claude Code Rules](../.claude/standards/CLAUDE_CODE_RULES.md) - **Mandatory first read**
2. [Engineering Standards](../.claude/standards/ENGINEERING_STANDARDS.md)
3. [Knowledge Base Index](../.claude/knowledge/README.md)
4. [PR Feedback Rules](../.claude/knowledge/pr-feedback/README.md)

### For Team Leads

Customize these:
1. [Engineering Standards](../.claude/standards/ENGINEERING_STANDARDS.md)
2. [Settings Guide](../.claude/standards/SETTINGS_GUIDE.md)
3. [GitHub Workflows](../.github/workflows/README.md)

---

## Content Directories

Beyond documentation, these directories contain valuable resources:

| Directory | Purpose |
|-----------|---------|
| [`methodologies/`](../methodologies/) | Development approaches and patterns |
| [`playbooks/`](../playbooks/) | Step-by-step guides for common tasks |
| [`prompts/`](../prompts/) | Reusable prompt templates |
| [`tips-and-tricks/`](../tips-and-tricks/) | Practical techniques by category |
| [`model-nuances/`](../model-nuances/) | AI model-specific guidance |
| [`examples/`](../examples/) | Before/after demonstrations |
| [`templates/`](../templates/) | Quick-start templates |
| [`specs/`](../specs/) | Standards and requirements |

---

## Maintenance

This index is maintained as part of the persuade documentation system. For documentation improvements:

1. Check the [Documentation Audit](./DOCUMENTATION_AUDIT.md) for priorities
2. Follow [Documentation Automation](../.claude/standards/DOCUMENTATION_AUTOMATION.md) patterns
3. Submit PRs with doc changes alongside code changes

---

*Last updated: January 2026*
