-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Description
Parent Issue
Part of #27
Description
Document the operator for users and contributors.
Scope
Operator README (operator/README.md)
- Purpose and architecture overview
- Development setup: prerequisites, build, test, run locally
- Project structure explanation
Experiment CRD reference
- All spec fields documented with types, defaults, and examples
- Inline scenarios mode vs. external dataset mode explained
- Status subresource fields documented
- Validation rules and constraints
User guide
- How to create an
ExperimentCR with step-by-step instructions - Configure triggers for automatic evaluation on agent changes
- Monitor experiment status via
kubectl - Complete example YAMLs for both inline and dataset modes
Update existing documentation
- Update root
CLAUDE.md: add operator section covering architecture, commands, and cross-references - Update root
README.md: reference the operator and link to its documentation
Acceptance Criteria
-
operator/README.mdwith development and architecture docs - CRD reference with all fields, types, and examples
- User guide with complete example YAMLs
- Root
CLAUDE.mdupdated with operator section - Root
README.mdupdated with operator reference
References
- Issue Testbench Operator: Reconcile Experiment CRD to TestWorkflows #27 full specification
- agent-runtime-operator for documentation patterns
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels
Type
Projects
Status
No status