OpenCodeHub Documentation

Everything you need to know about OpenCodeHub - from getting started to advanced features

Welcome to OpenCodeHub's comprehensive documentation. Whether you're new to the platform or looking to master advanced features, you'll find everything you need here.

🚀 Quick Links

📖 Documentation Sections

Getting Started

New to OpenCodeHub? Start here!

• Installation Guide - Set up OpenCodeHub (Docker or manual)
• Quick Start - Get up and running in 5 minutes
• Create Your First Repository - Push your first code

Core Features

Learn about OpenCodeHub's powerful features:

• Stacked Pull Requests ⭐
  Break large changes into reviewable stacks. Ship code faster.

• AI Code Review 🤖
  Get instant feedback from GPT-4 or Claude. Catch bugs automatically.

• Smart Merge Queue 🔀
  Automate merging with stack-aware CI optimization.

• Developer Metrics 📊
  Track velocity, review efficiency, and team performance.

• Slack Integration 💬
  Get actionable notifications in Slack. Review without leaving chat.

• CI/CD Pipelines ⚙️
  GitHub Actions-compatible workflows. Build, test, deploy.

Hands-On Tutorials

Step-by-step guides to master OpenCodeHub:

• Your First Stacked PR 🎓
  15-minute tutorial: Create your first stack of PRs

• AI-Powered Code Reviews
  Set up and use AI review for your projects

• Automated Deployment
  Build a complete CI/CD pipeline from scratch

Guides

Best practices and workflows:

• Team Workflows - Collaborate effectively
• Branch Protection - Secure your branches
• Webhooks - Integrate with external services
• Storage Adapters - Configure S3, GCS, or local storage

API Reference

Integrate OpenCodeHub into your tools:

• REST API - Complete API reference
• Webhooks - Event-driven integrations
• Authentication - API tokens and OAuth

Administration

For system administrators:

• Deployment Guide - Production deployment
• Configuration Reference - All config options
• Security Best Practices - Secure your instance
• Monitoring - Monitor health and performance

Development

Contributing to OpenCodeHub:

• Architecture - System design components
• Database Schema - Database tables
• Contributing - Dev environment setup
• Testing - Running tests

Reference & Support

• CLI Commands - Full CLI reference
• Glossary - Project terminology
• Troubleshooting - Fix common issues

🎯 Popular Topics

Stacked Pull Requests

The #1 feature that makes OpenCodeHub unique:

main branch
 └── PR #123: Add database schema ✅
      └── PR #124: Add auth service  🔍
           └── PR #125: Add login UI ⏳

• What are Stacked PRs?
• Create your first stack
• CLI reference

AI Code Review

Catch bugs before they reach production:

# AI Review finds:
# 🔴 CRITICAL: SQL injection on line 45
# 🟡 WARNING: N+1 query on line 128
# 🔵 INFO: Consider error handling on line 87

• Setup AI review
• Understanding output
• Cost optimization

Merge Queue

Merge automatically, in the right order:

och queue add 123 124 125
# → Queue handles everything:
#    - CI runs
#    - Rebasing
#    - Merging in order
#    - Zero manual work

• How it works
• Queue configuration
• Best practices

🔧 Installation

Quick Start (Docker)

# 1. Download docker-compose.yml
curl -O https://raw.githubusercontent.com/swadhinbiswas/OpencodeHub/main/docker-compose.yml

# 2. Configure
cp .env.example .env
# Edit .env with your settings

# 3. Start
docker-compose up -d

# 4. Create admin user
docker-compose exec app bun run scripts/seed-admin.ts

# 5. Open
open http://localhost:3000

Full installation guide →

Requirements

• Docker: 20.10+ (recommended)
• OR Node.js: 18+ with Bun or npm
• Database: PostgreSQL 14+ or SQLite
• Storage: Local, S3, Google Cloud Storage, or Azure Blob

🎓 Learning Paths

For Developers

1. Quick Start - Get familiar with the platform
2. Your First Stack - Learn stacked PRs
3. Team Workflows - Collaborate effectively

For Teams

1. Installation - Set up your instance
2. Team Workflows - Define your process
3. Branch Protection - Secure your code
4. CI/CD Setup - Automate everything

For Administrators

1. Deployment Guide - Production setup
2. Security Best Practices - Secure your instance
3. Monitoring - Track health
4. Configuration - Tune performance

💬 Community & Support

Get Help

• 📖 Documentation - You're here!
• 💬 Discord - Real-time chat, community support
• 🐛 GitHub Issues - Bug reports, feature requests
• 📧 Email Support - Direct support

Contributing

We welcome contributions!

• Contributing Guide - How to contribute
• Good First Issues - Easy issues for new contributors
• Roadmap - What's coming next

📝 Recent Updates

December 2024

• ✨ Added AI code review with GPT-4 and Claude support
• 🚀 Improved merge queue performance (60% faster)
• 📊 New developer metrics dashboard
• 🔧 100+ bug fixes and improvements

Full changelog →

🌟 Why OpenCodeHub?

🔍 Search Documentation

Can't find what you're looking for?

• Use the search bar above
• Check the FAQ
• Ask in Discord
• Browse GitHub Discussions

📄 License

OpenCodeHub is open source under the MIT License.

View license →

Ready to get started?

Install OpenCodeHub → | Quick Start → | Your First Stack →