How-To Guides
How-To Index for acp users solving specific problems
Document Type: How-To Index
Audience: ACP users solving specific problems
Last Updated: December 2025
Overview
How-To Guides help you accomplish specific tasks with ACP. Unlike tutorials (which teach) or reference (which documents), these guides are goal-oriented and assume you already understand the basics.
Guide Index
Getting Started
| Guide | Status | Description |
|---|---|---|
| Annotating Your Codebase | OUTLINE | Add ACP to an existing project |
| Migrating from JSDoc | OUTLINE | Bridge existing documentation |
| Configuring for Monorepos | OUTLINE | Multi-package project setup |
AI Tool Integration
| Guide | Status | Description |
|---|---|---|
| Integrating with Cursor | OUTLINE | Set up Cursor IDE |
| Integrating with Claude Code | OUTLINE | Set up Claude Code |
| Integrating with GitHub Copilot | OUTLINE | Set up Copilot |
| Integrating with Continue.dev | OUTLINE | Set up Continue |
Constraints & Safety
| Guide | Status | Description |
|---|---|---|
| Protecting Critical Code | OUTLINE | Use lock levels effectively |
| Setting Up Code Ownership | OUTLINE | Team ownership patterns |
| Tracking Constraint Violations | OUTLINE | Audit and monitoring |
Organization
| Guide | Status | Description |
|---|---|---|
| Defining Domain Boundaries | OUTLINE | Organize by business domain |
| Establishing Architectural Layers | OUTLINE | Layer-based organization |
| Using Variables Effectively | OUTLINE | Token-efficient references |
Advanced
| Guide | Status | Description |
|---|---|---|
| Optimizing for Large Codebases | OUTLINE | Performance tuning |
| Custom Primer Templates | OUTLINE | AI context customization |
| CI/CD Integration | OUTLINE | Automated workflows |
Guide Template
All How-To Guides follow this structure:
# How to [Accomplish Goal]
**Goal**: [What the reader will achieve]
**Prerequisites**: [What they need before starting]
**Time**: [Estimated time to complete]
---
## The Problem
[Brief description of the problem this solves]
---
## Solution
### Step 1: [First Step]
[Instructions]
### Step 2: [Second Step]
[Instructions]
...
---
## Verification
[How to verify success]
---
## Troubleshooting
[Common issues and solutions]
---
## Related
- [Related Guide 1]
- [Related Guide 2]Contributing Guides
Want to add a How-To Guide?
- Check if the topic is covered
- Use the template above
- Submit a PR to github.com/acp-protocol/docs
Select a guide from the index above to get started.