Files
cleveragents-core/docs/specification/index.md
HAL9000 07175518dc
CI / benchmark-publish (pull_request) Has been skipped
CI / lint (pull_request) Successful in 54s
CI / helm (pull_request) Successful in 41s
CI / build (pull_request) Successful in 51s
CI / push-validation (pull_request) Successful in 38s
CI / quality (pull_request) Successful in 1m13s
CI / typecheck (pull_request) Successful in 1m18s
CI / security (pull_request) Successful in 1m33s
CI / benchmark-regression (pull_request) Failing after 52s
CI / e2e_tests (pull_request) Successful in 3m54s
CI / integration_tests (pull_request) Successful in 4m16s
CI / unit_tests (pull_request) Successful in 7m21s
CI / docker (pull_request) Successful in 1m31s
CI / coverage (pull_request) Successful in 18m11s
CI / status-check (pull_request) Successful in 3s
docs(specification): split monolithic spec into docs/specification/ directory
Split the monolithic docs/specification.md (48,071 lines, ~3.2MB) into a
docs/specification/ directory with 10 logical sub-documents plus an index.

- docs/specification/index.md — Root entry point with navigation table
- docs/specification/overview.md — Overview, standards alignment, and glossary
- docs/specification/cli.md — Complete CLI command reference (~18,000 lines)
- docs/specification/core-concepts.md — Plan lifecycle, actors, tools, skills, resources, context
- docs/specification/behavior.md — Automation profiles, guardrails, plan correction
- docs/specification/tui.md — Text User Interface architecture and components
- docs/specification/configuration.md — Configuration keys and file schemas
- docs/specification/examples.md — End-to-end workflow examples
- docs/specification/architecture.md — System architecture, ACMS, storage, security
- docs/specification/milestones.md — Milestone delivery plan
- docs/specification/acms.md — ACMS v1 detailed specification

docs/specification.md replaced with a stub redirect pointing to docs/specification/index.md.
mkdocs.yml updated with hierarchical navigation for the new sub-documents.
CONTRIBUTING.md, docs/CONTRIBUTING.md, and all .opencode/ agent/skill references updated
to point to docs/specification/ instead of docs/specification.md.

ISSUES CLOSED: #4749
2026-05-05 15:52:21 +00:00

1.9 KiB

CleverAgents Specification

This directory contains the authoritative specification for CleverAgents, split into logical sub-documents for easier navigation and review.

Contents

Document Description
Overview & Glossary Overview, standards alignment, and glossary of core terms
CLI Commands Complete CLI command reference (~18,000 lines)
Core Concepts Plan lifecycle, actors, tools, skills, sessions, resources, and context
Behavior Automation profiles, guardrails, and plan correction
TUI Text User Interface architecture and components
Configuration Configuration keys and file schemas
Workflow Examples End-to-end workflow examples
Architecture System architecture, ACMS, storage, and security
Milestone Plan Milestone delivery plan
ACMS v1 ACMS v1 detailed specification (Milestone v3.4.0)

Source of Truth

docs/specification/ is the authoritative source of truth for architectural decisions and design details. Before beginning any task, always review the relevant parts of the specification to understand the intended design. When there is a discrepancy between the current codebase and the specification, always assume the specification is correct and align the code accordingly.

Navigation