# rdev Documentation

Documentation for the rdev remote development API.

## Quick Start

- **[Quick Reference](reference.md)** - Essential commands for daily operations
- **[API Documentation](api/README.md)** - REST API reference

## Documentation Structure

```
docs/
├── reference.md              # Quick reference for operations
├── api/                      # API documentation
│   ├── README.md            # API overview
│   ├── authentication.md    # API key auth
│   ├── sse-examples.md      # SSE streaming
│   └── errors.md            # Error codes
├── architecture/             # System design
│   ├── README.md            # Architecture overview
│   ├── hexagonal.md         # Ports & adapters
│   ├── security.md          # Auth, sanitization
│   └── streaming.md         # SSE protocol
├── operations/               # Operational guides
│   ├── deployment.md        # K8s deployment
│   ├── monitoring.md        # Prometheus/Grafana
│   ├── troubleshooting.md   # Common issues
│   ├── database-connections.md  # CRDB/Redis/Postgres
│   └── runbooks/            # Incident runbooks
├── features/                 # Feature documentation
│   └── multi-provider.md    # Code agent providers
└── plans/                    # Planning documents
```

## Developer Guides

For day-to-day development, see `.claude/guides/`:

| Guide | Description |
|-------|-------------|
| [local/setup.md](../.claude/guides/local/setup.md) | Local development setup |
| [local/testing.md](../.claude/guides/local/testing.md) | Running tests |
| [backend/go-guidelines.md](../.claude/guides/backend/go-guidelines.md) | Go coding standards |
| [backend/hexagonal.md](../.claude/guides/backend/hexagonal.md) | Hexagonal architecture |
| [ops/credentials.md](../.claude/guides/ops/credentials.md) | Credentials management |
| [ops/deploying.md](../.claude/guides/ops/deploying.md) | Deployment process |

## Key Resources

### Database Connections

See [operations/database-connections.md](operations/database-connections.md) for:
- CockroachDB SQL shell access
- Redis CLI access
- PostgreSQL access for rdev metadata

### Credentials

Infrastructure credentials (Cloudflare, Gitea, Woodpecker) are stored in:
- **Source:** `.secrets` file at repo root (gitignored)
- **Storage:** PostgreSQL with encryption
- **Guide:** [.claude/guides/ops/credentials.md](../.claude/guides/ops/credentials.md)

### Service URLs

| Service | External URL |
|---------|--------------|
| rdev API | https://rdev.masq-ops.orchard9.ai |
| CockroachDB Console | https://cockroachdb.threesix.ai |
| Gitea | https://git.threesix.ai |
| Woodpecker CI | https://ci.threesix.ai |

## Related

- **CLAUDE.md** - Project root documentation (always in context)
- **ai-lookup/** - Quick fact lookups for Claude
