OpenWriterControle/docs/README.md
Darren Hinde bf02ad0d5c
refactor: Rename repository to OpenAgents Control (#100)
* refactor: Rename repository to OpenAgents Control

Update all project references from "OpenAgents" to "OpenAgents Control":
- Updated core config files (package.json, registry.json)
- Updated documentation (README.md, docs/)
- Updated scripts (install.sh, update.sh, test scripts)
- Updated agent and command files
- Updated integrations and packages
- Updated all GitHub URLs to use OpenAgentsControl

Naming convention:
- Display name: "OpenAgents Control"
- Repository URL: OpenAgentsControl

* feat: Enable subagent-to-subagent delegation (ContextScout integration)

Allow coding-related subagents to call ContextScout for context discovery:
- CoderAgent: Can now discover coding standards on-demand
- TestEngineer: Can now discover test coverage and TDD guidelines
- CodeReviewer: Can now discover code review and security patterns
- BuildAgent: Can now discover build validation standards
- DocWriter: Can now discover documentation formatting guidelines

Changes per subagent:
- Added `task: true` to tools section
- Added permission allowlist for ContextScout only (deny all other delegation)
- Added Context Discovery workflow section with when-to-call guidance

This enables subagents to be self-sufficient for finding relevant standards
instead of relying on orchestrator to provide all context files.

Benefits:
- Subagents can discover what they need when context isn't explicit
- Maintains security (only ContextScout allowed via task tool)
- Follows existing patterns (uses task tool like main agents)

* fix: Set OPENCODE_BRANCH in CI tests to use PR branch for downloads

- Add OPENCODE_BRANCH environment variable to E2E tests
- Add OPENCODE_BRANCH environment variable to profile smoke tests
- Ensures tests download files from the PR branch instead of main
- Fixes E2E test failures after repository rename to OpenAgentsControl
2026-01-18 09:31:35 +00:00

107 lines
4.1 KiB
Markdown

# OpenAgents Control Documentation
Welcome to the OpenAgents Control documentation! This directory contains all documentation organized by topic.
## 📚 Documentation Index
### Getting Started
- **[Installation Guide](getting-started/installation.md)** - Complete installation guide with collision handling
- **[Collision Handling](getting-started/collision-handling.md)** - Quick reference for install script collision strategies
### Features
- **[System Builder](features/system-builder/)** - Build complete AI systems tailored to your domain
- [Quick Start](features/system-builder/README.md) - Get started with the system builder
- [Complete Guide](features/system-builder/guide.md) - Detailed documentation and examples
- **[Agent System Blueprint](features/agent-system-blueprint.md)** - Architecture patterns and how to extend the system
### Contributing
- **[Contributing Guide](contributing/CONTRIBUTING.md)** - How to contribute to the project
- **[Code of Conduct](contributing/CODE_OF_CONDUCT.md)** - Community guidelines
### GitHub
- **[GitHub Settings](github/GITHUB_SETTINGS.md)** - Repository settings checklist
## 🚀 Quick Links
### For New Users
- Start with the main [README](../README.md) in the repository root
- Follow the [Installation Guide](getting-started/installation.md)
- Use `opencode --agent openagent` to start building
- Read the [OpenAgent Guide](agents/openagent.md) to understand the workflow
### For Contributors
- Read the [Contributing Guide](contributing/CONTRIBUTING.md)
- Review the [Code of Conduct](contributing/CODE_OF_CONDUCT.md)
- Check out [good first issues](https://github.com/darrenhinde/OpenAgentsControl/labels/good%20first%20issue)
### For Advanced Users
- Study the [Agent System Blueprint](features/agent-system-blueprint.md)
- Try the [System Builder](features/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 Control**
→ [Installation Guide](getting-started/installation.md)
**...understand collision handling**
→ [Collision Handling](getting-started/collision-handling.md)
**...build a custom AI system**
→ [System Builder](features/system-builder/)
**...understand the architecture**
→ [Agent System Blueprint](features/agent-system-blueprint.md)
**...contribute to the project**
→ [Contributing Guide](contributing/CONTRIBUTING.md)
**...report a bug or request a feature**
→ [GitHub Issues](https://github.com/darrenhinde/OpenAgentsControl/issues)
## 💡 Additional Resources
- **Main README**: [../README.md](../README.md)
- **GitHub Repository**: https://github.com/darrenhinde/OpenAgentsControl
- **OpenCode CLI Docs**: https://opencode.ai/docs
- **Component Registry**: [../registry.json](../registry.json)
## 🤝 Community
- **Issues**: [Report bugs or request features](https://github.com/darrenhinde/OpenAgentsControl/issues)
- **Discussions**: [Ask questions and share ideas](https://github.com/darrenhinde/OpenAgentsControl/discussions)
- **Pull Requests**: [Contribute code](https://github.com/darrenhinde/OpenAgentsControl/pulls)
## 📝 License
This project is licensed under the MIT License. See [LICENSE](../LICENSE) for details.
---
**Need help?** Check the [Contributing Guide](contributing/CONTRIBUTING.md) or open an [issue](https://github.com/darrenhinde/OpenAgentsControl/issues).