Files
openrabbit/docs/README.md
latte 95937c4738
All checks were successful
AI Codebase Quality Review / ai-codebase-review (push) Successful in 36s
Add automated setup system for easy installation
- Add setup.sh interactive wizard for 5-minute setup
- Add INSTALL.md comprehensive installation guide
- Add templates/workflows/ directory with parameterized workflow templates
- Update README.md with prominent Installation section
- Update docs/README.md with installation links

The setup wizard automates:
- Platform selection (Gitea/GitHub)
- Bot configuration
- LLM provider setup
- Workflow file generation
- Configuration file creation

Users can now add OpenRabbit to any repository in under 5 minutes.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-16 11:33:05 +00:00

57 lines
3.2 KiB
Markdown

# AI Code Review Workflow Documentation
Enterprise-grade AI code review system for Gitea with automated issue triage, PR review, and codebase analysis.
## 📚 Documentation
| Document | Description |
|----------|-------------|
| [**Installation**](../INSTALL.md) | **Automated setup wizard & installation guide** |
| [Getting Started](getting-started.md) | Detailed setup walkthrough |
| [Configuration](configuration.md) | All configuration options |
| [Agents](agents.md) | Detailed agent documentation |
| [SECURITY](SECURITY.md) | Security best practices & scanning |
| [API Reference](api-reference.md) | Client and agent APIs |
| [Workflows](workflows.md) | Gitea workflow examples |
| [Troubleshooting](troubleshooting.md) | Common issues and solutions |
| [Enterprise](enterprise.md) | Enterprise features & compliance |
| [CLAUDE](CLAUDE.md) | Claude Code integration guide |
## Quick Links
- **🚀 Installation**: See [../INSTALL.md](../INSTALL.md) - Automated setup wizard
- **⚙️ Configuration**: See [Configuration](configuration.md)
- **🏢 Enterprise Features**: See [Enterprise](enterprise.md)
- **🔧 Troubleshooting**: See [Troubleshooting](troubleshooting.md)
## Architecture Overview
```
┌─────────────────────────────────────────────────────────────┐
│ Event Sources │
│ ┌──────────┐ ┌──────────┐ ┌──────────┐ │
│ │ PR Event │ │ Issue │ │ Schedule │ │
│ └────┬─────┘ └────┬─────┘ └────┬─────┘ │
└───────┼─────────────┼─────────────┼─────────────────────────┘
│ │ │
└─────────────┼─────────────┘
┌───────────────┐
│ Dispatcher │
└───────┬───────┘
┌─────────────┼─────────────┐
▼ ▼ ▼
┌───────────┐ ┌───────────┐ ┌───────────┐
│ Issue │ │ PR │ │ Codebase │
│ Agent │ │ Agent │ │ Agent │
└─────┬─────┘ └─────┬─────┘ └─────┬─────┘
│ │ │
└──────────────┼──────────────┘
┌─────────────────┐
│ Gitea API │
│ LLM Provider │
└─────────────────┘
```