OpenWriterControle/docs

OpenAgents Documentation

Welcome to the OpenAgents documentation! This directory contains all documentation organized by topic.

📚 Documentation Index

Getting Started

• Installation Guide - Complete installation guide with collision handling
• Collision Handling - Quick reference for install script collision strategies

Features

• System Builder - Build complete AI systems tailored to your domain
  • Quick Start - Get started with the system builder
  • Complete Guide - Detailed documentation and examples
• Agent System Blueprint - Architecture patterns and how to extend the system

Contributing

• Contributing Guide - How to contribute to the project
• Code of Conduct - Community guidelines

GitHub

• GitHub Settings - Repository settings checklist

🚀 Quick Links

For New Users

• Start with the main README in the repository root
• Follow the Installation Guide
• Use opencode --agent codebase-agent to start building

For Contributors

• Read the Contributing Guide
• Review the Code of Conduct
• Check out good first issues

For Advanced Users

• Study the Agent System Blueprint
• Try the System Builder
• Create custom agents and commands

📖 Documentation Structure

docs/
├── README.md                           # This file
├── getting-started/
│   ├── installation.md                 # Installation guide
│   └── collision-handling.md           # Collision handling reference
├── features/
│   ├── system-builder/
│   │   ├── README.md                   # System builder quick start
│   │   └── guide.md                    # System builder complete guide
│   └── agent-system-blueprint.md       # Architecture patterns
├── contributing/
│   ├── CODE_OF_CONDUCT.md              # Community guidelines
│   └── CONTRIBUTING.md                 # Contribution guide
└── github/
    └── GITHUB_SETTINGS.md              # Repository settings

🔍 Finding What You Need

I want to...

...install OpenAgents → Installation Guide

...understand collision handling → Collision Handling

...build a custom AI system → System Builder

...understand the architecture → Agent System Blueprint

...contribute to the project → Contributing Guide

...report a bug or request a feature → GitHub Issues

💡 Additional Resources

• Main README: ../README.md
• GitHub Repository: https://github.com/darrenhinde/OpenAgents
• OpenCode CLI Docs: https://opencode.ai/docs
• Component Registry: ../registry.json

🤝 Community

• Issues: Report bugs or request features
• Discussions: Ask questions and share ideas
• Pull Requests: Contribute code

📝 License

This project is licensed under the MIT License. See LICENSE for details.

---

Need help? Check the Contributing Guide or open an issue.