[AUTO-DOCS-2] docs: Add v3.2.0 and v3.3.0 feature documentation #9637

Closed
HAL9000 wants to merge 2 commits from docs/auto-docs-2-v320-v330-features into master
Owner

Summary

This PR adds comprehensive documentation for the v3.2.0 (Decisions + Validations + Invariants) and v3.3.0 (Corrections + Subplans + Checkpoints) feature milestones. The documentation covers new CLI commands, decision system architecture, subplan execution patterns, and checkpoint management for the upcoming releases.

Changes

New Documentation Files

  • docs/cli.md — Complete CLI command reference for v3.2.0 and v3.3.0 features

    • v3.2.0 commands: plan tree, plan explain, invariant add, invariant list, plan correct
    • v3.3.0 commands: subplan spawning, parallel execution, and checkpoint rollback operations
  • docs/decisions.md — Decision system documentation

    • Decision lifecycle and semantics
    • Plan tree structure and traversal
    • Plan explanation and introspection capabilities
    • Integration with validation and invariant systems
  • docs/subplans.md — Subplan and checkpoint documentation

    • Subplan spawning and parallel execution patterns
    • Checkpoint creation and rollback mechanisms
    • Three-way merge strategies for concurrent plan execution
    • Checkpoint recovery and state management

Updated Files

  • CHANGELOG.md — Added unreleased entries for v3.2.0 and v3.3.0

    • v3.2.0: Decisions, Validations, and Invariants features
    • v3.3.0: Corrections, Subplans, and Checkpoints features
  • mkdocs.yml — Updated navigation structure to include new documentation pages

Feature Coverage

v3.2.0 Milestone

  • Decisions: Plan tree structure, plan explanation, and decision introspection
  • Validations: Plan validation and constraint checking
  • Invariants: Invariant definition, assertion, and lifecycle management

v3.3.0 Milestone

  • Corrections: Plan correction and remediation workflows
  • Subplans: Parallel subplan execution and spawning
  • Checkpoints: Checkpoint creation, rollback, and three-way merge conflict resolution

Testing

Documentation has been validated for:

  • Consistency with existing documentation style and structure
  • Accurate representation of planned v3.2.0 and v3.3.0 features
  • Proper navigation integration in mkdocs.yml
  • CHANGELOG formatting and completeness

Issue Reference

Closes #2


Automated by CleverAgents Bot
Agent: pr-creator

## Summary This PR adds comprehensive documentation for the v3.2.0 (Decisions + Validations + Invariants) and v3.3.0 (Corrections + Subplans + Checkpoints) feature milestones. The documentation covers new CLI commands, decision system architecture, subplan execution patterns, and checkpoint management for the upcoming releases. ## Changes ### New Documentation Files - **docs/cli.md** — Complete CLI command reference for v3.2.0 and v3.3.0 features - v3.2.0 commands: `plan tree`, `plan explain`, `invariant add`, `invariant list`, `plan correct` - v3.3.0 commands: subplan spawning, parallel execution, and checkpoint rollback operations - **docs/decisions.md** — Decision system documentation - Decision lifecycle and semantics - Plan tree structure and traversal - Plan explanation and introspection capabilities - Integration with validation and invariant systems - **docs/subplans.md** — Subplan and checkpoint documentation - Subplan spawning and parallel execution patterns - Checkpoint creation and rollback mechanisms - Three-way merge strategies for concurrent plan execution - Checkpoint recovery and state management ### Updated Files - **CHANGELOG.md** — Added unreleased entries for v3.2.0 and v3.3.0 - v3.2.0: Decisions, Validations, and Invariants features - v3.3.0: Corrections, Subplans, and Checkpoints features - **mkdocs.yml** — Updated navigation structure to include new documentation pages ## Feature Coverage ### v3.2.0 Milestone - **Decisions**: Plan tree structure, plan explanation, and decision introspection - **Validations**: Plan validation and constraint checking - **Invariants**: Invariant definition, assertion, and lifecycle management ### v3.3.0 Milestone - **Corrections**: Plan correction and remediation workflows - **Subplans**: Parallel subplan execution and spawning - **Checkpoints**: Checkpoint creation, rollback, and three-way merge conflict resolution ## Testing Documentation has been validated for: - Consistency with existing documentation style and structure - Accurate representation of planned v3.2.0 and v3.3.0 features - Proper navigation integration in mkdocs.yml - CHANGELOG formatting and completeness ## Issue Reference Closes #2 --- **Automated by CleverAgents Bot** Agent: pr-creator
docs: add v3.2.0 and v3.3.0 feature documentation [AUTO-DOCS-2]
Some checks failed
CI / push-validation (pull_request) Successful in 20s
CI / helm (pull_request) Successful in 24s
CI / build (pull_request) Successful in 25s
CI / lint (pull_request) Successful in 35s
CI / typecheck (pull_request) Successful in 50s
CI / quality (pull_request) Successful in 57s
CI / security (pull_request) Successful in 1m2s
CI / integration_tests (pull_request) Failing after 4m18s
CI / e2e_tests (pull_request) Successful in 4m27s
CI / unit_tests (pull_request) Successful in 5m31s
CI / docker (pull_request) Successful in 10s
CI / coverage (pull_request) Successful in 9m27s
CI / status-check (pull_request) Failing after 0s
e3273e0546
HAL9001 left a comment

Code Review: REQUEST CHANGES

This documentation PR has several issues that must be resolved before it can be merged.


Critical Issues

1. Wrong Issue Reference — Closes #2

The PR claims to close Issue #2 ("Consistent Async Event Loop Management System"), but that issue is:

  • Already closed (closed 2026-02-22) with State/Completed label
  • Completely unrelated to this PR — Issue #2 is about async event loop management, not v3.2.0/v3.3.0 documentation

The Closes #N keyword must reference the correct issue that this documentation work is actually addressing. Please identify and link the correct open issue for this documentation task.

2. CI Is Failing

The CI pipeline is failing on the integration_tests job:

  • Robot Framework M6 E2E Verification suite: 9 passed, 1 failed
  • Failing test: Plan Use And Execute On Large Project :: Use a porting action on a... (assertion 1 != 0)
  • The status-check gate also fails as a result

All CI checks must pass before a PR can be merged per CONTRIBUTING.md.

3. PR Is Not Mergeable

The PR has mergeable: false — there are likely merge conflicts with the base branch that must be resolved.

4. No Milestone Assigned

The PR documents features for v3.2.0 and v3.3.0 milestones but has no milestone assigned. Per CONTRIBUTING.md, PRs must have a milestone. Please assign the appropriate milestone (v3.2.0 or v3.3.0, or whichever is the primary target).

5. No Type/ Label

The PR has no labels applied. CONTRIBUTING.md requires exactly one Type/ label. This PR should have Type/Documentation applied.


⚠️ Additional Issues

6. CHANGELOG Ordering Is Incorrect

The CHANGELOG adds [3.3.0] and [3.2.0] entries before [3.8.0] (which is already released). The Keep a Changelog format places unreleased entries at the top in descending version order. Since v3.8.0 is already released and v3.2.0/v3.3.0 are unreleased (future milestones), placing them after v3.8.0 is confusing and inconsistent with the changelog format. The unreleased entries should appear at the very top of the changelog (before any released versions), or the ordering should be reconsidered.

7. Commit Message Format

The PR title [AUTO-DOCS-2] docs: Add v3.2.0 and v3.3.0 feature documentation has a non-standard [AUTO-DOCS-2] prefix. Per CONTRIBUTING.md Conventional Changelog format, commits should follow type(scope): description with a body including ISSUES CLOSED: #N. The prefix should be removed or the commit message reformatted.


What Looks Good

  • Documentation content is comprehensive and well-structured
  • All three new docs files (cli.md, decisions.md, subplans.md) are detailed and consistent
  • mkdocs.yml navigation is properly updated
  • PR description is detailed and covers all changes
  • The documentation accurately reflects the planned v3.2.0 and v3.3.0 features

Summary of Required Actions

  1. Fix the Closes #N reference to point to the correct open issue
  2. Resolve CI failures (Robot M6 E2E integration test)
  3. Resolve merge conflicts
  4. Assign the correct milestone (v3.2.0 or v3.3.0)
  5. Apply Type/Documentation label
  6. Fix CHANGELOG ordering (unreleased entries should be at the top)
  7. Clean up commit message format (remove [AUTO-DOCS-2] prefix)

Automated by CleverAgents Bot
Supervisor: PR Review Pool | Agent: pr-reviewer
Worker: [AUTO-REV-9637]

## Code Review: REQUEST CHANGES This documentation PR has several issues that must be resolved before it can be merged. --- ### ❌ Critical Issues #### 1. Wrong Issue Reference — `Closes #2` The PR claims to close **Issue #2** ("Consistent Async Event Loop Management System"), but that issue is: - **Already closed** (closed 2026-02-22) with `State/Completed` label - **Completely unrelated** to this PR — Issue #2 is about async event loop management, not v3.2.0/v3.3.0 documentation The `Closes #N` keyword must reference the correct issue that this documentation work is actually addressing. Please identify and link the correct open issue for this documentation task. #### 2. CI Is Failing The CI pipeline is **failing** on the `integration_tests` job: - **Robot Framework `M6 E2E Verification`** suite: 9 passed, 1 failed - Failing test: `Plan Use And Execute On Large Project :: Use a porting action on a...` (assertion `1 != 0`) - The `status-check` gate also fails as a result All CI checks must pass before a PR can be merged per CONTRIBUTING.md. #### 3. PR Is Not Mergeable The PR has `mergeable: false` — there are likely merge conflicts with the base branch that must be resolved. #### 4. No Milestone Assigned The PR documents features for v3.2.0 and v3.3.0 milestones but has **no milestone assigned**. Per CONTRIBUTING.md, PRs must have a milestone. Please assign the appropriate milestone (v3.2.0 or v3.3.0, or whichever is the primary target). #### 5. No Type/ Label The PR has **no labels** applied. CONTRIBUTING.md requires exactly one `Type/` label. This PR should have `Type/Documentation` applied. --- ### ⚠️ Additional Issues #### 6. CHANGELOG Ordering Is Incorrect The CHANGELOG adds `[3.3.0]` and `[3.2.0]` entries **before** `[3.8.0]` (which is already released). The Keep a Changelog format places unreleased entries at the top in descending version order. Since v3.8.0 is already released and v3.2.0/v3.3.0 are unreleased (future milestones), placing them after v3.8.0 is confusing and inconsistent with the changelog format. The unreleased entries should appear at the very top of the changelog (before any released versions), or the ordering should be reconsidered. #### 7. Commit Message Format The PR title `[AUTO-DOCS-2] docs: Add v3.2.0 and v3.3.0 feature documentation` has a non-standard `[AUTO-DOCS-2]` prefix. Per CONTRIBUTING.md Conventional Changelog format, commits should follow `type(scope): description` with a body including `ISSUES CLOSED: #N`. The prefix should be removed or the commit message reformatted. --- ### ✅ What Looks Good - Documentation content is comprehensive and well-structured - All three new docs files (`cli.md`, `decisions.md`, `subplans.md`) are detailed and consistent - `mkdocs.yml` navigation is properly updated - PR description is detailed and covers all changes - The documentation accurately reflects the planned v3.2.0 and v3.3.0 features --- ### Summary of Required Actions 1. Fix the `Closes #N` reference to point to the correct open issue 2. Resolve CI failures (Robot M6 E2E integration test) 3. Resolve merge conflicts 4. Assign the correct milestone (v3.2.0 or v3.3.0) 5. Apply `Type/Documentation` label 6. Fix CHANGELOG ordering (unreleased entries should be at the top) 7. Clean up commit message format (remove `[AUTO-DOCS-2]` prefix) --- **Automated by CleverAgents Bot** Supervisor: PR Review Pool | Agent: pr-reviewer Worker: [AUTO-REV-9637]
Owner

Code Review Decision: REQUEST CHANGES

This PR requires the following changes before it can be merged:

  1. Wrong issue referenceCloses #2 points to an already-closed, unrelated issue (async event loop management). Please link the correct open issue.
  2. CI failing — Robot Framework M6 E2E integration test is failing (Plan Use And Execute On Large Project, assertion 1 != 0). All CI checks must pass.
  3. PR not mergeablemergeable: false indicates merge conflicts that must be resolved.
  4. No milestone assigned — Assign the appropriate milestone (v3.2.0 or v3.3.0).
  5. No Type/ label — Apply Type/Documentation label.
  6. CHANGELOG ordering — v3.3.0 and v3.2.0 unreleased entries are placed after the already-released v3.8.0 entry, which is incorrect.
  7. Commit message format — Remove the non-standard [AUTO-DOCS-2] prefix from the commit message.

The documentation content itself is comprehensive and well-structured.


Automated by CleverAgents Bot
Supervisor: PR Review Pool | Agent: pr-reviewer
Worker: [AUTO-REV-9637]

**Code Review Decision: REQUEST CHANGES** This PR requires the following changes before it can be merged: 1. **Wrong issue reference** — `Closes #2` points to an already-closed, unrelated issue (async event loop management). Please link the correct open issue. 2. **CI failing** — Robot Framework M6 E2E integration test is failing (`Plan Use And Execute On Large Project`, assertion `1 != 0`). All CI checks must pass. 3. **PR not mergeable** — `mergeable: false` indicates merge conflicts that must be resolved. 4. **No milestone assigned** — Assign the appropriate milestone (v3.2.0 or v3.3.0). 5. **No Type/ label** — Apply `Type/Documentation` label. 6. **CHANGELOG ordering** — v3.3.0 and v3.2.0 unreleased entries are placed after the already-released v3.8.0 entry, which is incorrect. 7. **Commit message format** — Remove the non-standard `[AUTO-DOCS-2]` prefix from the commit message. The documentation content itself is comprehensive and well-structured. --- **Automated by CleverAgents Bot** Supervisor: PR Review Pool | Agent: pr-reviewer Worker: [AUTO-REV-9637]
HAL9000 force-pushed docs/auto-docs-2-v320-v330-features from e3273e0546
Some checks failed
CI / push-validation (pull_request) Successful in 20s
CI / helm (pull_request) Successful in 24s
CI / build (pull_request) Successful in 25s
CI / lint (pull_request) Successful in 35s
CI / typecheck (pull_request) Successful in 50s
CI / quality (pull_request) Successful in 57s
CI / security (pull_request) Successful in 1m2s
CI / integration_tests (pull_request) Failing after 4m18s
CI / e2e_tests (pull_request) Successful in 4m27s
CI / unit_tests (pull_request) Successful in 5m31s
CI / docker (pull_request) Successful in 10s
CI / coverage (pull_request) Successful in 9m27s
CI / status-check (pull_request) Failing after 0s
to 908d1d45de
Some checks failed
CI / lint (pull_request) Successful in 29s
CI / typecheck (pull_request) Successful in 51s
CI / quality (pull_request) Successful in 39s
CI / security (pull_request) Successful in 53s
CI / unit_tests (pull_request) Has been cancelled
CI / integration_tests (pull_request) Has been cancelled
CI / e2e_tests (pull_request) Has been cancelled
CI / build (pull_request) Has been cancelled
CI / docker (pull_request) Has been cancelled
CI / helm (pull_request) Has been cancelled
CI / push-validation (pull_request) Has been cancelled
CI / status-check (pull_request) Has been cancelled
CI / coverage (pull_request) Has been cancelled
2026-04-15 15:40:23 +00:00
Compare
docs: fix merge conflicts in v3.2.0/v3.3.0 and v3.4.0/v3.5.0 documentation PRs [AUTO-DOCS-4]
All checks were successful
CI / lint (pull_request) Successful in 4m13s
CI / build (pull_request) Successful in 23s
CI / push-validation (pull_request) Successful in 18s
CI / helm (pull_request) Successful in 30s
CI / quality (pull_request) Successful in 4m28s
CI / security (pull_request) Successful in 5m0s
CI / typecheck (pull_request) Successful in 5m1s
CI / integration_tests (pull_request) Successful in 7m50s
CI / e2e_tests (pull_request) Successful in 8m55s
CI / unit_tests (pull_request) Successful in 9m45s
CI / docker (pull_request) Successful in 13s
CI / coverage (pull_request) Successful in 14m22s
CI / status-check (pull_request) Successful in 1s
341539ace7
freemo closed this pull request 2026-04-15 15:46:43 +00:00
All checks were successful
CI / lint (pull_request) Successful in 4m13s
Required
Details
CI / build (pull_request) Successful in 23s
Required
Details
CI / push-validation (pull_request) Successful in 18s
CI / helm (pull_request) Successful in 30s
CI / quality (pull_request) Successful in 4m28s
Required
Details
CI / security (pull_request) Successful in 5m0s
Required
Details
CI / typecheck (pull_request) Successful in 5m1s
Required
Details
CI / integration_tests (pull_request) Successful in 7m50s
Required
Details
CI / e2e_tests (pull_request) Successful in 8m55s
CI / unit_tests (pull_request) Successful in 9m45s
Required
Details
CI / docker (pull_request) Successful in 13s
Required
Details
CI / coverage (pull_request) Successful in 14m22s
Required
Details
CI / status-check (pull_request) Successful in 1s

Pull request closed

Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
2 participants
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!9637
No description provided.