cclohmar/OpenWriterControle
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
OpenWriterControle/docs/README.md
Darren Hinde d7a4cb8031
feat: Context path configuration and documentation reorganization (#143) 
* feat: add npm package support for @openagents/control

- Convert package to publishable npm package with scoped name @openagents/control
- Add CLI entry point bin/oac.js for global installation
- Create .npmignore to exclude dev files and node_modules
- Configure package.json with proper files, bin, and metadata
- Add comprehensive NPM_PUBLISHING_GUIDE.md with publishing instructions
- Package size: 610KB (2.4MB unpacked) with 353 files
- Includes .opencode/tool/ directory without node_modules
- CLI command: oac (e.g., 'oac developer' or 'oac --help')

Users can install with: npm install -g @openagents/control

* chore: remove telegram bot files from package

- Delete .opencode/_lib/telegram-bot.ts (unused)
- Delete .opencode/plugin/telegram-notify.ts (depends on deleted file)
- Remove _lib directory reference from package.json files field
- Reduces package size from 610KB to 607KB
- Total files: 351 (down from 353)

* chore: remove all telegram references from registry and docs

- Remove telegram-bot and telegram-notify plugin entries from registry.json
- Remove telegram plugin references from all profiles (developer, business, full, advanced)
- Update profile-validation.md to remove telegram from business profile documentation
- Clean package with no telegram dependencies

* docs: enhance README clarity and add configuration examples

- Add Core Philosophy section with 4 key principles
- Add Quick Concepts for First-Time Users (scannable format)
- Add prominent Oh My OpenCode comparison link
- Add comprehensive Model Configuration section
- Add Customizing Agents section with practical examples
- Streamline model selection recommendations
- Add emoji headers for visual consistency
- Remove redundant FAQ entry

Addresses user feedback about documentation clarity and first-time user experience.

* refactor: remove OpenImplementer agent

- Delete OpenImplementer agent file (redundant with OpenAgent)
- Remove from registry.json and all profiles
- Update OpenCoder delegation rules (now handles 1-4 files directly)
- Clean up all context file references
- Remove from commands and documentation

Rationale: OpenImplementer only added 1 file to OpenAgent's capability (3→4 files), creating unnecessary complexity. OpenAgent and OpenCoder provide clearer separation: OpenAgent for general + focused tasks (1-4 files), OpenCoder for complex architecture (4+ files).

* fix: remove stale OpenImplementer reference from OpenCoder

- Remove OpenImplementer from Available Subagents list
- Clarify CoderAgent is used via TaskManager for complex tasks
- Keep delegation rules as-is (execute 1-4 files directly, delegate complex to CoderAgent)

* docs: remove remaining OpenImplementer references

- Update developer profile description (OpenAgent vs OpenCoder)
- Update registry.json profile description
- Update docs/README.md to remove OpenImplementer
- Update CHANGELOG.md to reflect simplified architecture

All OpenImplementer references now removed. Registry validation passes.

* docs: enhance README with first-time user improvements

- Add 'your secret weapon!' to Context System in Quick Concepts
- Add First-Time User Checklist after Get Started section
- Add visual comparison table for AOC vs Oh My OpenCode in FAQ
- Improve scannability and clarity for new users

Based on DocWriter review recommendations.

* docs: clarify project-context.md is created during installation

Minor enhancement to First-Time User Checklist step 2 for extra clarity.

* docs: change 'I' to 'we' for collaborative tone

- Update 'Why I Built This' to 'Why We Built This'
- Change 'I've spent' to 'We've spent'
- Change 'I use this' to 'We use this'
- Makes the project feel more collaborative and team-oriented

* docs: make intro more neutral and objective

- Change 'Why We Built This' to 'Why This Exists'
- Remove personal perspective ('We've spent 14+ years')
- Change 'We use this' to 'It's built for shipping'
- More professional and objective tone

* docs: major README rewrite based on user feedback

Key improvements based on real user confusion:

1. **Clear 'What Is AOC?' section** - Explains scaffold vs plugin approach upfront
2. **Model configuration prominently featured** - Addresses #1 user question
3. **Hook with quantified paradox** - Grabs attention in 15 seconds
4. **Context System promoted** - Moved to top, explains the differentiator
5. **Comparison table** - AOC vs Oh My OpenCode side-by-side
6. **Eliminated 60% redundancy** - Merged overlapping sections
7. **Simplified deep dives** - Model config and customization tightened

Based on user feedback: 'I just expected that behaviour because it was not
documented properly... the only thing really lacking was a clear explanation
of its purpose and how to configure models and adjust agents.'

Addresses: Confusion about scaffold vs plugin, model configuration, and
first-time user expectations.

* chore: publish package as @nextsystems/oac v0.7.0

- Changed package name from @openagents/control to @nextsystems/oac
- Successfully published to npm registry
- Users can install with: npm install -g @nextsystems/oac
- CLI command: oac

* feat: add context path configuration and reorganize documentation

- Add configurable context root via paths.json (@reference support)
- Add /add-context command for interactive context setup
- Move NPM_PUBLISHING_GUIDE.md to context system (guides/npm-publishing.md)
- Add GitHub issues workflow guide
- Update agents to support custom context directories
- Update navigation with new guides and file counts

This enables projects to use custom context directories (e.g., .context, .ai/context)
while maintaining backward compatibility with default .opencode/context/ structure.
2026-01-30 17:18:05 +00:00

118 lines
4.5 KiB
Markdown
Raw Blame History

# 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) - Complete overview and quick start
- **CHANGELOG**: [../CHANGELOG.md](../CHANGELOG.md) - Version history and updates
- **GitHub Repository**: https://github.com/darrenhinde/OpenAgentsControl
- **OpenCode CLI Docs**: https://opencode.ai/docs
- **Component Registry**: [../registry.json](../registry.json)
## 📌 Current Version
**v0.6.0** (January 28, 2026)
Latest updates:
- ExternalScout subagent for fetching live library documentation (18+ libraries)
- Enhanced ContextScout with multi-model optimization
- Complete command and agent documentation
- Simplified agent architecture (OpenAgent + OpenCoder)
## 🤝 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).
Reference in a new issue View git blame Copy permalink