| title | Open Edison Documentation |
|---|---|
| description | Comprehensive documentation for Open Edison - the single-user MCP proxy server |
import { Card, Cards } from 'fumadocs-ui/components/card' import { Callout } from 'fumadocs-ui/components/callout'
Welcome to Open Edison documentation! This directory contains comprehensive guides for users, developers, and contributors to the single-user MCP proxy server.🎯 Core Documentation core/
Essential guides for using Open Edison:
- Project Structure - Architecture overview and system design
- Configuration Guide - JSON configuration and setup
- MCP Proxy Usage - Managing and using MCP servers
⚡ Quick Reference quick-reference/
Fast lookup guides:
- API Reference - Complete REST API documentation
- Configuration Quick Start - Essential config options
🏗️ Architecture architecture/
Design decisions and technical deep-dives:
- Single-User Design - Why simplicity over multi-user complexity
- JSON vs Database config decisions: integrated into the configuration guide
💻 Development development/
Guidelines for contributors and developers:
- Development Guide - Comprehensive development documentation
- Contributing - How to contribute to Open Edison
- Testing Strategy - Testing approach and guidelines
🚀 Deployment deployment/
Production deployment guides:
- Docker Deployment - Container-based deployment
- Local Installation - Local development setup
New to Open Edison? Start here:
- Project Structure - Understand the architecture
- Configuration Quick Start - Basic setup
- MCP Proxy Usage - Start using MCP servers
| I want to... | Go here |
|---|---|
| 🚀 Set up Open Edison | Configuration Quick Start |
| 🔧 Configure MCP servers | Configuration Guide |
| 🏗️ Understand the architecture | Project Structure |
| ⚡ API reference | API Reference |
| 🧪 Write tests | Testing Strategy |
| 🐳 Deploy with Docker | Docker Deployment |
| 💻 Contribute code | Development Guide |
All documentation follows these principles:
- ✅ Simple - Reflects single-user, self-hosted nature
- 🎯 Practical - Includes working examples
- 📚 Complete - Covers essential use cases
- 🔄 Current - Updated with system changes
- 💡 Clear - Easy to understand and follow
When updating documentation:
- Keep the single-user focus throughout
- Update relevant sections when code changes
- Test all code examples
- Use consistent terminology
- Follow the simplicity principle
Need help? Check the main README or explore the specific guides above.
Open Edison - Simple, self-hosted MCP proxy for single users.