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

4.6 KiB

Raw Blame History

OpenAgents Control Repository Context

Purpose: Context files specific to the OpenAgents Control repository

Last Updated: 2026-01-30

Function	Files	Purpose
Concepts	2 files	Core ideas and principles
Examples	1 file	Working code samples
Guides	10 files	Step-by-step workflows
Lookup	4 files	Quick reference tables
Errors	1 file	Common issues + solutions

Concepts (Core Ideas)

File	Topic	Priority
`concepts/subagent-testing-modes.md`	Standalone vs delegation testing	⭐⭐⭐⭐⭐

When to read: Before testing any subagent

Examples (Working Code)

File	Topic	Priority
`examples/subagent-prompt-structure.md`	Optimized subagent prompt template	⭐⭐⭐⭐

When to read: When creating or optimizing subagent prompts

Guides (Step-by-Step)

File	Topic	Priority
`guides/testing-subagents.md`	How to test subagents standalone	⭐⭐⭐⭐⭐
`guides/adding-agent.md`	How to add new agents	⭐⭐⭐⭐
`guides/testing-agent.md`	How to test agents	⭐⭐⭐⭐
`guides/external-libraries-workflow.md`	How to handle external library dependencies	⭐⭐⭐⭐
`guides/github-issues-workflow.md`	How to work with GitHub issues and project board	⭐⭐⭐⭐
`guides/npm-publishing.md`	How to publish package to npm	⭐⭐⭐
`guides/updating-registry.md`	How to update registry	⭐⭐⭐
`guides/debugging.md`	How to debug issues	⭐⭐⭐
`guides/resolving-installer-wildcard-failures.md`	Fix wildcard context install failures	⭐⭐⭐
`guides/creating-release.md`	How to create releases	⭐⭐

When to read: When performing specific tasks

Lookup (Quick Reference)

File	Topic	Priority
`lookup/subagent-test-commands.md`	Subagent testing commands	⭐⭐⭐⭐⭐
`lookup/file-locations.md`	Where files are located	⭐⭐⭐⭐
`lookup/commands.md`	Available slash commands	⭐⭐⭐

When to read: Quick command lookups

Errors (Troubleshooting)

File	Topic	Priority
`errors/tool-permission-errors.md`	Tool permission issues	⭐⭐⭐⭐⭐

When to read: When tests fail with permission errors

Core Concepts (Foundational)

File	Topic	Priority
`core-concepts/agents.md`	How agents work	⭐⭐⭐⭐⭐
`core-concepts/evals.md`	How testing works	⭐⭐⭐⭐⭐
`core-concepts/registry.md`	How registry works	⭐⭐⭐⭐
`core-concepts/categories.md`	How organization works	⭐⭐⭐

When to read: First time working in this repo

Loading Strategy

For Subagent Testing:

Load concepts/subagent-testing-modes.md (understand modes)
Load guides/testing-subagents.md (step-by-step)
Reference lookup/subagent-test-commands.md (commands)
If errors: Load errors/tool-permission-errors.md

For Agent Creation:

Load core-concepts/agents.md (understand structure)
Load guides/adding-agent.md (step-by-step)
If using external libraries: Load guides/external-libraries-workflow.md (fetch docs)
Load examples/subagent-prompt-structure.md (if subagent)
Load guides/testing-agent.md (validate)

For Issue Management:

Load guides/github-issues-workflow.md (understand workflow)
Create issues with proper labels and templates
Add to project board for tracking
Process requests systematically

For Debugging:

Load guides/debugging.md (general approach)
Load specific error file from errors/
Reference lookup/file-locations.md (find files)

File Size Compliance

All files follow MVI principle (<200 lines):

✅ Concepts: <100 lines
✅ Examples: <100 lines
✅ Guides: <150 lines
✅ Lookup: <100 lines
✅ Errors: <150 lines

../core/ - Core system context (standards, patterns)
../core/context-system/ - Context management system
quick-start.md - 2-minute repo orientation
../content-creation/navigation.md - Content creation principles
../to-be-consumed/claude-code-docs/plugins.md - Claude Code extension docs

Contributing

When adding new context files:

Follow MVI principle (<200 lines)
Use function-based organization (concepts/, examples/, guides/, lookup/, errors/)
Update this README.md navigation
Add cross-references to related files
Validate with /context validate

4.6 KiB Raw Blame History