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

8.5 KiB

Raw Blame History

Lookup: File Locations

Purpose: Quick reference for finding files

Directory Tree

opencode-agents/
├── .opencode/
│   ├── agent/
│   │   ├── core/                    # Core system agents
│   │   ├── development/             # Dev specialists
│   │   ├── content/                 # Content creators
│   │   ├── data/                    # Data analysts
│   │   ├── product/                 # Product managers (ready)
│   │   ├── learning/                # Educators (ready)
│   │   └── subagents/               # Delegated specialists
│   │       ├── code/                # Code-related
│   │       ├── core/                # Core workflows
│   │       ├── system-builder/      # System generation
│   │       └── utils/               # Utilities
│   ├── command/                     # Slash commands
│   ├── context/                     # Shared knowledge
│   │   ├── core/                    # Core standards & workflows
│   │   ├── development/             # Dev context
│   │   ├── content-creation/        # Content creation context
│   │   ├── data/                    # Data context
│   │   ├── product/                 # Product context
│   │   ├── learning/                # Learning context
│   │   └── openagents-repo/         # Repo-specific context
│   ├── prompts/                     # Model-specific variants
│   ├── tool/                        # Custom tools
│   └── plugin/                      # Plugins
├── evals/
│   ├── framework/                   # Eval framework (TypeScript)
│   │   ├── src/                     # Source code
│   │   ├── scripts/                 # Test utilities
│   │   └── docs/                    # Framework docs
│   └── agents/                      # Agent test suites
│       ├── core/                    # Core agent tests
│       ├── development/             # Dev agent tests
│       └── content/                 # Content agent tests
├── scripts/
│   ├── registry/                    # Registry management
│   ├── validation/                  # Validation tools
│   ├── testing/                     # Test utilities
│   ├── versioning/                  # Version management
│   ├── docs/                        # Doc tools
│   └── maintenance/                 # Maintenance
├── docs/                            # Documentation
│   ├── agents/                      # Agent docs
│   ├── contributing/                # Contribution guides
│   ├── features/                    # Feature docs
│   └── getting-started/             # User guides
├── registry.json                    # Component catalog
├── install.sh                       # Installer
├── VERSION                          # Current version
└── package.json                     # Node dependencies

Where Is...?

Component	Location
Core agents	`.opencode/agent/core/`
Category agents	`.opencode/agent/{category}/`
Subagents	`.opencode/agent/subagents/`
Commands	`.opencode/command/`
Context files	`.opencode/context/`
Prompt variants	`.opencode/prompts/{category}/{agent}/`
Tools	`.opencode/tool/`
Plugins	`.opencode/plugin/`
Agent tests	`evals/agents/{category}/{agent}/`
Eval framework	`evals/framework/src/`
Registry scripts	`scripts/registry/`
Validation scripts	`scripts/validation/`
Documentation	`docs/`
Registry	`registry.json`
Installer	`install.sh`
Version	`VERSION`

Where Do I Add...?

What	Where
New core agent	`.opencode/agent/core/{name}.md`
New category agent	`.opencode/agent/{category}/{name}.md`
New subagent	`.opencode/agent/subagents/{category}/{name}.md`
New command	`.opencode/command/{name}.md`
New context	`.opencode/context/{category}/{name}.md`
Agent tests	`evals/agents/{category}/{agent}/tests/`
Test config	`evals/agents/{category}/{agent}/config/config.yaml`
Documentation	`docs/{section}/{topic}.md`
Script	`scripts/{purpose}/{name}.sh`

Specific File Paths

Core Files

registry.json                        # Component catalog
install.sh                           # Main installer
update.sh                            # Update script
VERSION                              # Current version (0.5.0)
package.json                         # Node dependencies
CHANGELOG.md                         # Release notes
README.md                            # Main documentation

Core Agents

.opencode/agent/core/openagent.md
.opencode/agent/core/opencoder.md
.opencode/agent/meta/system-builder.md

Development Agents

.opencode/agent/development/frontend-specialist.md
.opencode/agent/development/devops-specialist.md

.opencode/agent/development/frontend-specialist.md .opencode/agent/development/devops-specialist.md


### Content Agents

.opencode/agent/content/copywriter.md .opencode/agent/content/technical-writer.md


### Key Subagents

.opencode/agent/TestEngineer.md .opencode/agent/CodeReviewer.md .opencode/agent/CoderAgent.md .opencode/agent/TaskManager.md .opencode/agent/DocWriter.md


### Core Context

.opencode/context/core/standards/code-quality.md .opencode/context/core/standards/documentation.md .opencode/context/core/standards/test-coverage.md .opencode/context/core/standards/security-patterns.md .opencode/context/core/workflows/task-delegation.md .opencode/context/core/workflows/code-review.md


### Registry Scripts

scripts/registry/validate-registry.sh scripts/registry/auto-detect-components.sh scripts/registry/register-component.sh scripts/registry/validate-component.sh


### Validation Scripts

scripts/validation/validate-context-refs.sh scripts/validation/validate-test-suites.sh scripts/validation/setup-pre-commit-hook.sh


### Eval Framework

evals/framework/src/sdk/ # Test runner evals/framework/src/evaluators/ # Rule evaluators evals/framework/src/collector/ # Session collection evals/framework/src/types/ # TypeScript types


---

## Path Patterns

### Agents

.opencode/agent/{category}/{agent-name}.md


**Examples**:
- `.opencode/agent/core/openagent.md`
- `.opencode/agent/development/frontend-specialist.md`
- `.opencode/agent/TestEngineer.md`

### Context

.opencode/context/{category}/{topic}.md


**Examples**:
- `.opencode/context/core/standards/code-quality.md`
- `.opencode/context/development/react-patterns.md`
- `.opencode/context/content-creation/principles/copywriting-frameworks.md`

### Tests

evals/agents/{category}/{agent-name}/ ├── config/config.yaml └── tests/{test-name}.yaml


**Examples**:
- `evals/agents/core/openagent/tests/smoke-test.yaml`
- `evals/agents/development/frontend-specialist/tests/approval-gate.yaml`

### Scripts

scripts/{purpose}/{action}-{target}.sh


**Examples**:
- `scripts/registry/validate-registry.sh`
- `scripts/validation/validate-test-suites.sh`
- `scripts/versioning/bump-version.sh`

---

## Naming Conventions

### Files

- **Agents**: `{name}.md` or `{domain}-specialist.md`
- **Context**: `{topic}.md`
- **Tests**: `{test-name}.yaml`
- **Scripts**: `{action}-{target}.sh`
- **Docs**: `{topic}.md`

### Directories

- **Categories**: lowercase, singular (e.g., `development`, `content`)
- **Purposes**: lowercase, descriptive (e.g., `registry`, `validation`)

---

## Quick Lookups

### Find Agent File

```bash
# By name
find .opencode/agent -name "{agent-name}.md"

# By category
ls .opencode/agent/{category}/

# All agents
find .opencode/agent -name "*.md" -not -path "*/subagents/*"

Find Test File

# By agent
ls evals/agents/{category}/{agent}/tests/

# All tests
find evals/agents -name "*.yaml"

Find Context File

# By category
ls .opencode/context/{category}/

# All context
find .opencode/context -name "*.md"

Find Script

# By purpose
ls scripts/{purpose}/

# All scripts
find scripts -name "*.sh"

Quick start: quick-start.md
Categories: core-concepts/categories.md
Commands: lookup/commands.md

Last Updated: 2025-12-10
Version: 0.5.0

8.5 KiB Raw Blame History