cleveragents/cleveragents-core
cleveragents/cleveragents-core
4
0
Fork 3
Code Issues 6.1k Pull requests 489 Projects Releases Packages Wiki Activity Actions

docs: update and extend documentation for v3.8.0 changes #3585

Merged
freemo merged 1 commit from docs/v3.8.0-documentation-updates into master 2026-04-05 21:06:49 +00:00
Conversation 2 Commits 1 Files changed 4 +357 -3
freemo commented 2026-04-05 20:06:12 +00:00
Owner
Copy link

Summary

Documentation updates for v3.8.0 changes. All updates extend existing documentation — no existing content was removed.

Changes

  • docs/reference/plan_cli.md — Added note about legacy/v3 plan workflow mixing being disallowed (v3.8.0, #1577). Users attempting to mix legacy plan commands with v3 plan workflows now receive a clear error with migration guidance.

  • docs/reference/uko_runtime.md — Documented v3.8.0 UKO provenance tracking: sourceResource, validFrom, and isCurrent fields on every typed triple; revision chain for temporal queries across indexing runs (#891). Updated the architecture diagram and added a new "Provenance Tracking" section with query patterns and temporal query examples.

  • docs/reference/decision_correction.md — Added CorrectionAttemptRecord section documenting the correction_attempts table, CorrectionAttemptState lifecycle (pending → executing → complete/failed), CorrectionAttemptRepository API, usage examples, and database schema notes (#920).

  • docs/modules/uko-provenance.md (new) — Dedicated module guide for UKO provenance tracking covering: purpose, how provenance is attached during indexing, revision chain mechanics, query patterns (current-only, point-in-time, by source resource), persistence format, BDD coverage summary, and gotchas (naive datetime rejection, non-atomic re-indexing, in-memory backend limitations).

Docs skipped (already current)

  • README.md — v3.8.0 highlights already present (UKO provenance, JSON-RPC 2.0, Invariant reconciliation)
  • CHANGELOG.md — v3.8.0 entry already comprehensive
  • docs/architecture.md — Invariant reconciliation and UKO provenance already documented
  • docs/api/core.md — DomainBaseModel and InvariantService already documented
  • docs/api/a2a.md — JSON-RPC 2.0 breaking change already documented
  • docs/reference/session_cli.md — Session export/import already documented
  • docs/reference/uko_indexer.md — ProvenanceMetadata and ProvenancedTriple already documented
  • docs/reference/temporal_data_model.md — Temporal data model already documented

Automated by CleverAgents Bot
Supervisor: Documentation | Agent: ca-docs-writer

## Summary Documentation updates for v3.8.0 changes. All updates extend existing documentation — no existing content was removed. ### Changes - **`docs/reference/plan_cli.md`** — Added note about legacy/v3 plan workflow mixing being disallowed (v3.8.0, #1577). Users attempting to mix legacy plan commands with v3 plan workflows now receive a clear error with migration guidance. - **`docs/reference/uko_runtime.md`** — Documented v3.8.0 UKO provenance tracking: `sourceResource`, `validFrom`, and `isCurrent` fields on every typed triple; revision chain for temporal queries across indexing runs (#891). Updated the architecture diagram and added a new "Provenance Tracking" section with query patterns and temporal query examples. - **`docs/reference/decision_correction.md`** — Added `CorrectionAttemptRecord` section documenting the `correction_attempts` table, `CorrectionAttemptState` lifecycle (`pending → executing → complete/failed`), `CorrectionAttemptRepository` API, usage examples, and database schema notes (#920). - **`docs/modules/uko-provenance.md`** *(new)* — Dedicated module guide for UKO provenance tracking covering: purpose, how provenance is attached during indexing, revision chain mechanics, query patterns (current-only, point-in-time, by source resource), persistence format, BDD coverage summary, and gotchas (naive datetime rejection, non-atomic re-indexing, in-memory backend limitations). ### Docs skipped (already current) - `README.md` — v3.8.0 highlights already present (UKO provenance, JSON-RPC 2.0, Invariant reconciliation) - `CHANGELOG.md` — v3.8.0 entry already comprehensive - `docs/architecture.md` — Invariant reconciliation and UKO provenance already documented - `docs/api/core.md` — `DomainBaseModel` and `InvariantService` already documented - `docs/api/a2a.md` — JSON-RPC 2.0 breaking change already documented - `docs/reference/session_cli.md` — Session export/import already documented - `docs/reference/uko_indexer.md` — `ProvenanceMetadata` and `ProvenancedTriple` already documented - `docs/reference/temporal_data_model.md` — Temporal data model already documented --- **Automated by CleverAgents Bot** Supervisor: Documentation | Agent: ca-docs-writer
docs: update and extend documentation for v3.8.0 changes
Some checks failed
CI / lint (pull_request) Successful in 21s
Details
CI / typecheck (pull_request) Successful in 52s
Details
CI / security (pull_request) Successful in 55s
Details
CI / quality (pull_request) Successful in 39s
Details
CI / build (pull_request) Successful in 29s
Details
CI / helm (pull_request) Successful in 23s
Details
CI / unit_tests (pull_request) Failing after 6m49s
Details
CI / docker (pull_request) Has been skipped
Details
CI / e2e_tests (pull_request) Successful in 17m22s
Details
CI / integration_tests (pull_request) Failing after 23m1s
Details
CI / coverage (pull_request) Successful in 11m3s
Details
CI / status-check (pull_request) Failing after 1s
Details
CI / benchmark-publish (pull_request) Has been skipped
Details
CI / benchmark-regression (pull_request) Successful in 56m57s
Details
a0ac30d5de 
- docs/reference/plan_cli.md: add note about legacy/v3 plan workflow
  mixing being disallowed (introduced in v3.8.0, issue #1577)
- docs/reference/uko_runtime.md: document v3.8.0 provenance tracking
  (sourceResource, validFrom, isCurrent on typed triples) and revision
  chain for temporal queries across indexing runs (issue #891)
- docs/reference/decision_correction.md: add CorrectionAttemptRecord
  section documenting the correction_attempts table, state lifecycle,
  repository API, and usage examples (issue #920)
- docs/modules/uko-provenance.md: new module guide for UKO provenance
  tracking covering purpose, how provenance is attached, revision chain
  mechanics, query patterns, persistence format, BDD coverage, and gotchas
freemo added this to the v3.8.0 milestone 2026-04-05 20:23:33 +00:00
freemo commented 2026-04-05 21:01:37 +00:00
Author
Owner
Copy link

CI Status Analysis

PR Status: Awaiting merge — blocked by pre-existing CI failure

CI Summary

Check Status
build ✅ Success
lint ✅ Success
typecheck ✅ Success
quality ✅ Success
security ✅ Success
helm ✅ Success
docker ✅ Skipped
unit_tests ❌ Failing
e2e_tests ⏳ Running
integration_tests ⏳ Running
coverage ⏳ Running

Root Cause: Pre-existing Failure

The unit_tests failure is NOT caused by this PR. Evidence:

  1. This PR only changes documentation files (docs/modules/uko-provenance.md, docs/reference/decision_correction.md, docs/reference/plan_cli.md, docs/reference/uko_runtime.md) — no Python code was modified.

  2. The same unit_tests failure exists on master (commit bd5238f7) — the base branch has the same failure with the same error.

Situation

The branch protection rule requires CI / unit_tests* to pass before merging. Since this is a pre-existing failure on master unrelated to this docs PR, this PR is blocked until the unit test failure on master is resolved.

This PR is ready to merge once the pre-existing unit test failure on master is fixed. No changes to this PR are needed.

Automated by CleverAgents Bot
Supervisor: Implementation | Agent: ca-issue-worker

## CI Status Analysis **PR Status:** Awaiting merge — blocked by pre-existing CI failure ### CI Summary | Check | Status | |-------|--------| | build | ✅ Success | | lint | ✅ Success | | typecheck | ✅ Success | | quality | ✅ Success | | security | ✅ Success | | helm | ✅ Success | | docker | ✅ Skipped | | **unit_tests** | ❌ **Failing** | | e2e_tests | ⏳ Running | | integration_tests | ⏳ Running | | coverage | ⏳ Running | ### Root Cause: Pre-existing Failure The `unit_tests` failure is **NOT caused by this PR**. Evidence: 1. **This PR only changes documentation files** (`docs/modules/uko-provenance.md`, `docs/reference/decision_correction.md`, `docs/reference/plan_cli.md`, `docs/reference/uko_runtime.md`) — no Python code was modified. 2. **The same `unit_tests` failure exists on `master`** (commit `bd5238f7`) — the base branch has the same failure with the same error. ### Situation The branch protection rule requires `CI / unit_tests*` to pass before merging. Since this is a pre-existing failure on master unrelated to this docs PR, this PR is blocked until the unit test failure on master is resolved. **This PR is ready to merge** once the pre-existing unit test failure on master is fixed. No changes to this PR are needed. --- **Automated by CleverAgents Bot** Supervisor: Implementation | Agent: ca-issue-worker
freemo merged commit 9e74fceddc into master 2026-04-05 21:06:49 +00:00
freemo commented 2026-04-05 21:15:26 +00:00
Author
Owner
Copy link

Updated CI Status Analysis

PR Status: Blocked by pre-existing CI failures on master (not caused by this PR)

Final CI Summary

Check PR Status Master Status
build ✅ Success ✅ Success
lint ✅ Success ✅ Success
typecheck ✅ Success ✅ Success
quality ✅ Success ✅ Success
security ✅ Success ✅ Success
helm ✅ Success ✅ Success
docker ✅ Skipped ✅ Skipped
coverage ✅ Success ❌ Cancelled
e2e_tests ✅ Success ✅ Success
unit_tests ❌ Failing ❌ Failing
integration_tests ❌ Failing ❌ Failing

Conclusion

Both unit_tests and integration_tests are failing on master (bd5238f7) as well as on this PR branch. This PR only changes 4 documentation markdown files — it cannot cause test failures.

This PR is blocked by pre-existing test failures on master that require human intervention to fix. The PR itself is correct and ready to merge once the master branch test failures are resolved.

Action needed: Fix the failing unit_tests and integration_tests on master, then this PR can be merged.

Automated by CleverAgents Bot
Supervisor: Implementation | Agent: ca-issue-worker

## Updated CI Status Analysis **PR Status:** Blocked by pre-existing CI failures on master (not caused by this PR) ### Final CI Summary | Check | PR Status | Master Status | |-------|-----------|---------------| | build | ✅ Success | ✅ Success | | lint | ✅ Success | ✅ Success | | typecheck | ✅ Success | ✅ Success | | quality | ✅ Success | ✅ Success | | security | ✅ Success | ✅ Success | | helm | ✅ Success | ✅ Success | | docker | ✅ Skipped | ✅ Skipped | | coverage | ✅ Success | ❌ Cancelled | | e2e_tests | ✅ Success | ✅ Success | | **unit_tests** | ❌ **Failing** | ❌ **Failing** | | **integration_tests** | ❌ **Failing** | ❌ **Failing** | ### Conclusion Both `unit_tests` and `integration_tests` are failing on **master** (`bd5238f7`) as well as on this PR branch. This PR only changes 4 documentation markdown files — it cannot cause test failures. **This PR is blocked by pre-existing test failures on master that require human intervention to fix.** The PR itself is correct and ready to merge once the master branch test failures are resolved. **Action needed:** Fix the failing `unit_tests` and `integration_tests` on master, then this PR can be merged. --- **Automated by CleverAgents Bot** Supervisor: Implementation | Agent: ca-issue-worker
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
auto/needs-reevaluation
Controller deferred this PR; awaiting Phase 6+ scope-evaluator or operator re-enablement.

  
controller-managed
Auto-agents controller manages this PR/issue (see tools/controller/deploy/RUNBOOK.md). Remove this label to abandon controller management.

  
auto/blocked-by-deps
PR blocked by an open issue dependency. Operator must close the dep (or remove the dependency link) before the merge driver can act. Auto-cleared by merge_drive when no open deps remain.

  
auto/ci-timeout
Most recent merge cycle hit CI timeout. Driver excludes this PR while last merge_cycle row is < 30 min old; label persists thereafter as visible history.

  
auto/claimed-implementer
Currently being processed by an implementer worker.

  
auto/claimed-merge
Currently being processed by the merge driver.

  
auto/claimed-reviewer
Currently being processed by a reviewer worker.

  
auto/driver-down
Merge driver heartbeat stale; pipeline halted. Closed automatically on next clean tick.

  
auto/invariant-violation
Detected master commit violating the strict merge invariant. Tracked as an issue (not a PR label); kept here for label completeness.

  
auto/last-attempt-tier-0
In-cycle escalation: most recent attempt ran at the Tier 0 slot (`tier-0`). Slot's model defined in .opencode/models/tiers.yaml.

  
auto/last-attempt-tier-1
In-cycle escalation: most recent attempt ran at the Tier 1 slot (`tier-1`). Slot's model defined in .opencode/models/tiers.yaml.

  
auto/last-attempt-tier-2
In-cycle escalation: most recent attempt ran at the Tier 2 slot (`tier-2`). Slot's model defined in .opencode/models/tiers.yaml. Gated behind IMPLEMENTER_ESCALATION_TIER2_ENABLED.

  
auto/last-attempt-tier-min
In-cycle escalation: most recent attempt ran at the Tier -1 slot (`tier-min`). Slot's model defined in .opencode/models/tiers.yaml. Suffix is ``-min`` (not ``--1``) so the Forgejo UI reads naturally.

  
Automation Tracking
Tracking issues used by the AI Automation system for agents to communicate and report.

  
auto/needs-conflict-resolution
Rebase conflict needs LLM conflict-resolver.

  
auto/needs-implementer
Failing CI needs implementer attention.

  
auto/postmortem
Documenting a driver incident or rollback.

  
auto/ready-to-merge
Reviewer has APPROVED this PR and no later REQUEST_CHANGES is outstanding. The merge driver requires this label to even consider a PR for merging. Set by the reviewer worker on APPROVE; cleared on REQUEST_CHANGES.

  
auto/restart-throttled
Train repeatedly lost master-tempo races. Driver excludes via merge_cycle until cooldown elapses; label persists as visible history.

  
auto/revert
Revert PR backing out an invariant violation. Fast-tracked through the merge driver.

  
auto/sentinel
Sentinel PR duplicated from upstream into a personal fork by tools/duplicate_prs_to_fork.py for pipeline testing. Lives only in the fork; the canonical pipeline never sees it.

  
auto/stale-inactivity
No implementer activity for N days. Flagged for human review. Auto-cleared on next push to head branch.

  
auto/unstable
Repeatedly fails on current master (>= 3 ci-fail-on-rebased-sha releases in 12 h). Excluded from driver until human triage.

  
Blocked
A ticket in a blocked state and unable to complete until some other task is completed first.

  
Bounty
$100
 A bounty of $100 for any open-source contributor who provides a MR that solves this issue

  
Bounty
$1000
 A bounty of $1000 for any open-source contributor who provides a MR that solves this issue

  
Bounty
$10000
 A bounty of $10000 for any open-source contributor who provides a MR that solves this issue

  
Bounty
$20
 A bounty of $20 for any open-source contributor who provides a MR that solves this issue

  
Bounty
$2000
 A bounty of $2000 for any open-source contributor who provides a MR that solves this issue

  
Bounty
$250
 A bounty of $250 for any open-source contributor who provides a MR that solves this issue

  
Bounty
$50
 A bounty of $50 for any open-source contributor who provides a MR that solves this issue

  
Bounty
$500
 A bounty of $500 for any open-source contributor who provides a MR that solves this issue

  
Bounty
$5000
 A bounty of $5000 for any open-source contributor who provides a MR that solves this issue

  
Bounty
$750
 A bounty of $750 for any open-source contributor who provides a MR that solves this issue

  
MoSCoW
Could have
 Could have feature in order to satisfy the epic/legendary.

  
MoSCoW
Must have
 Must have feature in order to satisfy the epic/legendary.

  
MoSCoW
Should have
 Should have feature in order to satisfy the epic/legendary.

  
Needs Feedback
There are questions in the ticket that can not be completed until the project owner provides clarity.

  
Points
1
 1 man-hours worth of work for an expert with no learning curve.

  
Points
13
 13 man-hours worth of work for an expert with no learning curve.

  
Points
2
 2 man-hours worth of work for an expert with no learning curve.

  
Points
21
 21 man-hours worth of work for an expert with no learning curve.

  
Points
3
 3 man-hours worth of work for an expert with no learning curve.

  
Points
34
 34 man-hours worth of work for an expert with no learning curve.

  
Points
5
 5 man-hours worth of work for an expert with no learning curve.

  
Points
55
 55 man-hours worth of work for an expert with no learning curve.

  
Points
8
 8 man-hours worth of work for an expert with no learning curve.

  
Points
88
 88 man-hours worth of work for an expert with no learning curve.

  
Priority
Backlog
 This ticket has backlogged priority and is not to be worked on yet

  
Priority
CI Blocker
 Critical priority issue that blocks CI/CD pipeline and prevents PR merges

  
Priority
Critical
 The priority is critical

  
Priority
High
 The priority is high

  
Priority
Low
 The priority is low

  
Priority
Medium
 The priority is medium

  
Signed-off: Owner
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.

  
Signed-off: Scrum Master
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.

  
Signed-off: Tech Lead
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.

  
Spike
A ticket for learning a tool or technology that is needed to be able to do future planning and design.

  
State
Completed
 The ticket has been fully implemented, completed, and merged with the source code. This label should only be applied once a ticket is closed.

  
State
Duplicate
 A ticket that represents the same content as an existing ticket.

  
State
In Progress
 A ticket that is actively being developed.

  
State
In Review
 A ticket that has had some code completed to implement but is waiting to pass peer review and is not yet merged in.

  
State
Paused
 This ticket's work started but wasn't finished. It's on hold (likely in a feature branch) and will be resumed later, either due to a blocker or a delay.

  
State
Unverified
 All new tickets start in this state. A developer may set it to show the ticket is unverified. This means we haven't agreed to work on it. It will either move to a verified state or be closed as wontdo.

  
State
Verified
 The issue has been verified by a developer as legitimate. It will be worked on and verified tickets are now considered part of the backlog.

  
State
Wont Do
 This ticket has been decided it wont be done. This may mean the bug has been determined to not be real (cant verify) or the feature is one we have decided we dont want to adopt.

  
Type
Automation
 Any edits or discussion about the AI automated coding system.

  
Type
Bug
 Something that doesnt work as intended.

  
Type
Discussion
 Anytime a ticket represents a discussion about a subject and doesnt fall into one of the other categories.

  
Type
Documentation
 An error or improvement needed in the documentation.

  
Type
Epic
 Any first tier epic. That is, an epic which contains only issues as children and will not have sub-epics.

  
Type
Feature
 Some new functionality not present.

  
Type
Legendary
 A type of Epic which will contain other Epics.

  
Type
Refactor
 A code change that restructures existing code without changing its external behavior.

  
Type
Support
 Someone needs help using the project.

  
Type
Task
 A generic task that doesnt fit into the other type categories.

  
Type
Testing
 Work exclusively focusing on fixing or expanding testing.

No labels
auto/needs-reevaluation
controller-managed
auto/blocked-by-deps
auto/ci-timeout
auto/claimed-implementer
auto/claimed-merge
auto/claimed-reviewer
auto/driver-down
auto/invariant-violation
auto/last-attempt-tier-0
auto/last-attempt-tier-1
auto/last-attempt-tier-2
auto/last-attempt-tier-min
Automation Tracking
auto/needs-conflict-resolution
auto/needs-implementer
auto/postmortem
auto/ready-to-merge
auto/restart-throttled
auto/revert
auto/sentinel
auto/stale-inactivity
auto/unstable
Blocked
Bounty
$100
Bounty
$1000
Bounty
$10000
Bounty
$20
Bounty
$2000
Bounty
$250
Bounty
$50
Bounty
$500
Bounty
$5000
Bounty
$750
MoSCoW
Could have
MoSCoW
Must have
MoSCoW
Should have
Needs Feedback
Points
1
Points
13
Points
2
Points
21
Points
3
Points
34
Points
5
Points
55
Points
8
Points
88
Priority
Backlog
Priority
CI Blocker
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Signed-off: Owner
Signed-off: Scrum Master
Signed-off: Tech Lead
Spike
State
Completed
State
Duplicate
State
In Progress
State
In Review
State
Paused
State
Unverified
State
Verified
State
Wont Do
Type
Automation
Type
Bug
Type
Discussion
Type
Documentation
Type
Epic
Type
Feature
Type
Legendary
Type
Refactor
Type
Support
Type
Task
Type
Testing
Milestone
Clear milestone
No items
No milestone
v3.8.0
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
cleveragents/cleveragents-core!3585
No description provided.