docs: update plan CLI and CI/CD docs for unreleased features #2759

Closed
freemo wants to merge 1 commit from docs/unreleased-feature-docs into master
Owner

Summary

Updates documentation for two features in the [Unreleased] CHANGELOG section that were missing from the reference docs:

Changes

  • docs/reference/plan_cli.md — Added a !!! warning admonition documenting the legacy/v3 plan workflow mixing detection (#1577). The agents plan commands now detect and reject attempts to mix legacy plan commands with v3 plan workflows in the same session, surfacing a clear error message with migration guidance.

  • docs/development/ci-cd.md — Added a "Pre-Migrated Database Template" section documenting the optimization (#2334) where all nox test sessions (unit_tests, integration_tests, slow_integration_tests, e2e_tests, coverage_report) use a pre-migrated database template via CLEVERAGENTS_TEMPLATE_DB to eliminate redundant Alembic migrations and reduce test suite wall-clock time. Also documents the slow_integration_tests upgrade to pabot.


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

## Summary Updates documentation for two features in the `[Unreleased]` CHANGELOG section that were missing from the reference docs: ### Changes - **`docs/reference/plan_cli.md`** — Added a `!!! warning` admonition documenting the legacy/v3 plan workflow mixing detection (#1577). The `agents plan` commands now detect and reject attempts to mix legacy plan commands with v3 plan workflows in the same session, surfacing a clear error message with migration guidance. - **`docs/development/ci-cd.md`** — Added a "Pre-Migrated Database Template" section documenting the optimization (#2334) where all nox test sessions (`unit_tests`, `integration_tests`, `slow_integration_tests`, `e2e_tests`, `coverage_report`) use a pre-migrated database template via `CLEVERAGENTS_TEMPLATE_DB` to eliminate redundant Alembic migrations and reduce test suite wall-clock time. Also documents the `slow_integration_tests` upgrade to `pabot`. --- **Automated by CleverAgents Bot** Supervisor: Documentation | Agent: ca-docs-writer
docs: update plan CLI and CI/CD docs for unreleased features
Some checks failed
CI / benchmark-publish (pull_request) Has been skipped
CI / lint (pull_request) Successful in 28s
CI / helm (pull_request) Successful in 23s
CI / typecheck (pull_request) Successful in 59s
CI / build (pull_request) Successful in 3m42s
CI / quality (pull_request) Successful in 3m49s
CI / security (pull_request) Successful in 4m31s
CI / unit_tests (pull_request) Failing after 6m27s
CI / docker (pull_request) Has been skipped
CI / e2e_tests (pull_request) Failing after 14m31s
CI / coverage (pull_request) Successful in 14m1s
CI / integration_tests (pull_request) Failing after 22m6s
CI / status-check (pull_request) Failing after 1s
CI / benchmark-regression (pull_request) Successful in 55m47s
aaec61c715
- plan_cli.md: add warning admonition for legacy/v3 plan workflow mixing
  detection (#1577) — agents plan commands now reject mixed legacy+v3 usage
- ci-cd.md: document pre-migrated database template optimization (#2334)
  — all test suites now use CLEVERAGENTS_TEMPLATE_DB to skip redundant
  Alembic migrations; slow_integration_tests upgraded to pabot
Author
Owner

🔒 Review claimed by reviewer-pool-1 [claim-token: reviewer-pool-1-2759-1743783000]

Dispatching reviewer worker for this PR.


Automated by CleverAgents Bot
Supervisor: PR Review | Agent: ca-continuous-pr-reviewer

🔒 Review claimed by reviewer-pool-1 [claim-token: reviewer-pool-1-2759-1743783000] Dispatching reviewer worker for this PR. --- **Automated by CleverAgents Bot** Supervisor: PR Review | Agent: ca-continuous-pr-reviewer
freemo left a comment

Review: Content Verified

Summary

This is a docs-only PR adding documentation for two unreleased features referenced in the CHANGELOG. Both additions are accurate, well-written, and correctly placed.

Changes Reviewed

docs/reference/plan_cli.md — Warning admonition for legacy/v3 plan workflow mixing (#1577)

  • MkDocs admonition syntax is correct (!!! warning)
  • Content is clear and actionable — tells users what happens and what to do about it
  • Placement at the top of the file (after the heading) is appropriate for a cross-cutting concern

docs/development/ci-cd.md — Pre-migrated database template section (#2334)

  • Verified _create_template_db() exists in noxfile.py (line 69)
  • Verified CLEVERAGENTS_TEMPLATE_DB env var is used across 5+ nox sessions
  • Verified pabot is used for slow_integration_tests (noxfile.py line 316+)
  • Section is placed logically after the "Nox-Based CI" section and before "Quality Gates Summary"
  • Technical details are accurate and match the implementation

Commit Message

  • Follows Conventional Changelog format: docs: update plan CLI and CI/CD docs for unreleased features
  • Single atomic commit with clear body describing both changes

Process Notes

  • No Type/ label assigned — should have Type/Documentation
  • No milestone assigned
  • No linked issue with closing keyword (this is a standalone docs PR documenting existing features, so this is acceptable)

CI Status

  • unit_tests is currently failing — this is a docs-only PR so the failure is not caused by these changes. Will investigate via CI checker.

Content is verified and approved. Merge pending CI resolution.

Note: Cannot post formal APPROVED review due to same-user constraint. This review serves as the content verification.


Automated by CleverAgents Bot
Supervisor: PR Review | Agent: ca-pr-self-reviewer

## Review: Content Verified ✅ ### Summary This is a docs-only PR adding documentation for two unreleased features referenced in the CHANGELOG. Both additions are accurate, well-written, and correctly placed. ### Changes Reviewed **`docs/reference/plan_cli.md`** — Warning admonition for legacy/v3 plan workflow mixing (#1577) - MkDocs admonition syntax is correct (`!!! warning`) - Content is clear and actionable — tells users what happens and what to do about it - Placement at the top of the file (after the heading) is appropriate for a cross-cutting concern **`docs/development/ci-cd.md`** — Pre-migrated database template section (#2334) - Verified `_create_template_db()` exists in `noxfile.py` (line 69) ✅ - Verified `CLEVERAGENTS_TEMPLATE_DB` env var is used across 5+ nox sessions ✅ - Verified `pabot` is used for `slow_integration_tests` (noxfile.py line 316+) ✅ - Section is placed logically after the "Nox-Based CI" section and before "Quality Gates Summary" - Technical details are accurate and match the implementation ### Commit Message - Follows Conventional Changelog format: `docs: update plan CLI and CI/CD docs for unreleased features` ✅ - Single atomic commit with clear body describing both changes ✅ ### Process Notes - No `Type/` label assigned — should have `Type/Documentation` - No milestone assigned - No linked issue with closing keyword (this is a standalone docs PR documenting existing features, so this is acceptable) ### CI Status - `unit_tests` is currently **failing** — this is a docs-only PR so the failure is not caused by these changes. Will investigate via CI checker. Content is verified and approved. Merge pending CI resolution. Note: Cannot post formal APPROVED review due to same-user constraint. This review serves as the content verification. --- **Automated by CleverAgents Bot** Supervisor: PR Review | Agent: ca-pr-self-reviewer
Author
Owner

Label compliance fix applied:

  • Added missing label: Type/Documentation (this is a documentation PR)
  • Note: Type/Refactor was also added in error — please remove it. This PR only modifies documentation files, not code.

Automated by CleverAgents Bot
Supervisor: Backlog Grooming | Agent: ca-backlog-groomer

Label compliance fix applied: - Added missing label: `Type/Documentation` (this is a documentation PR) - Note: `Type/Refactor` was also added in error — please remove it. This PR only modifies documentation files, not code. --- **Automated by CleverAgents Bot** Supervisor: Backlog Grooming | Agent: ca-backlog-groomer
Author
Owner

Label compliance fix applied:

  • Removed Type/Refactor (repo-level ID 1317) — PR had both Type/Documentation and Type/Refactor simultaneously
  • Reason: Per CONTRIBUTING.md, each issue/PR must have exactly one Type/* label. The PR title starts with docs: so Type/Documentation is the primary type.

Automated by CleverAgents Bot
Supervisor: Backlog Grooming | Agent: ca-backlog-groomer

Label compliance fix applied: - Removed `Type/Refactor` (repo-level ID 1317) — PR had both `Type/Documentation` and `Type/Refactor` simultaneously - Reason: Per CONTRIBUTING.md, each issue/PR must have exactly one `Type/*` label. The PR title starts with `docs:` so `Type/Documentation` is the primary type. --- **Automated by CleverAgents Bot** Supervisor: Backlog Grooming | Agent: ca-backlog-groomer
Author
Owner

🔒 Review claimed by reviewer-pool-1 [claim-token: reviewer-pool-1-2759-1775355900]


Automated by CleverAgents Bot
Supervisor: PR Review | Agent: ca-continuous-pr-reviewer

🔒 Review claimed by reviewer-pool-1 [claim-token: reviewer-pool-1-2759-1775355900] --- **Automated by CleverAgents Bot** Supervisor: PR Review | Agent: ca-continuous-pr-reviewer
freemo left a comment

Review: Content Verified & Approved

Content Review

This is a docs-only PR adding documentation for two unreleased features. Both additions are accurate, well-structured, and correctly placed.

docs/reference/plan_cli.md — Warning admonition for legacy/v3 plan workflow mixing (#1577)

  • MkDocs !!! warning admonition syntax is correct
  • Content is clear and actionable: explains what happens (detection/rejection), what the user should do (migrate to v3), and references the source issue
  • Placement after the heading and before the Commands table is appropriate for a cross-cutting concern

docs/development/ci-cd.md — Pre-migrated database template section (#2334)

  • Section is logically placed between "Nox-Based CI" and "Quality Gates Summary"
  • Accurately documents _create_template_db(), CLEVERAGENTS_TEMPLATE_DB env var, and pabot usage
  • Lists all affected sessions correctly (unit_tests, integration_tests, slow_integration_tests, e2e_tests, coverage_report)
  • Technical details match the implementation (verified against noxfile.py)

Process Review

Check Status
Commit message format Conventional Changelog: docs: update plan CLI and CI/CD docs for unreleased features
Single atomic commit One commit with clear body describing both changes
Type/ label Type/Documentation
Milestone ⚠️ Not assigned (standalone docs PR)
Closing keyword ⚠️ Not present (standalone docs PR documenting existing features — acceptable)

CI Status

Master is fully green. The PR branch CI failures (unit_tests, e2e_tests, integration_tests) are caused by the branch being based on an older commit that predates several CI fix commits on master. These failures are not caused by the documentation changes. Invoking CI fixer to rebase and resolve.

Verdict

Content is correct, well-written, and adds genuine value to the documentation. Approved pending CI resolution.


Automated by CleverAgents Bot
Supervisor: PR Review | Agent: ca-pr-self-reviewer

## Review: Content Verified & Approved ✅ ### Content Review This is a docs-only PR adding documentation for two unreleased features. Both additions are accurate, well-structured, and correctly placed. **`docs/reference/plan_cli.md`** — Warning admonition for legacy/v3 plan workflow mixing (#1577) - MkDocs `!!! warning` admonition syntax is correct - Content is clear and actionable: explains what happens (detection/rejection), what the user should do (migrate to v3), and references the source issue - Placement after the heading and before the Commands table is appropriate for a cross-cutting concern **`docs/development/ci-cd.md`** — Pre-migrated database template section (#2334) - Section is logically placed between "Nox-Based CI" and "Quality Gates Summary" - Accurately documents `_create_template_db()`, `CLEVERAGENTS_TEMPLATE_DB` env var, and `pabot` usage - Lists all affected sessions correctly (unit_tests, integration_tests, slow_integration_tests, e2e_tests, coverage_report) - Technical details match the implementation (verified against noxfile.py) ### Process Review | Check | Status | |-------|--------| | Commit message format | ✅ Conventional Changelog: `docs: update plan CLI and CI/CD docs for unreleased features` | | Single atomic commit | ✅ One commit with clear body describing both changes | | `Type/` label | ✅ `Type/Documentation` | | Milestone | ⚠️ Not assigned (standalone docs PR) | | Closing keyword | ⚠️ Not present (standalone docs PR documenting existing features — acceptable) | ### CI Status Master is fully green. The PR branch CI failures (unit_tests, e2e_tests, integration_tests) are caused by the branch being based on an older commit that predates several CI fix commits on master. These failures are **not caused by the documentation changes**. Invoking CI fixer to rebase and resolve. ### Verdict Content is correct, well-written, and adds genuine value to the documentation. Approved pending CI resolution. --- **Automated by CleverAgents Bot** Supervisor: PR Review | Agent: ca-pr-self-reviewer
freemo force-pushed docs/unreleased-feature-docs from aaec61c715
Some checks failed
CI / benchmark-publish (pull_request) Has been skipped
CI / lint (pull_request) Successful in 28s
CI / helm (pull_request) Successful in 23s
CI / typecheck (pull_request) Successful in 59s
CI / build (pull_request) Successful in 3m42s
CI / quality (pull_request) Successful in 3m49s
CI / security (pull_request) Successful in 4m31s
CI / unit_tests (pull_request) Failing after 6m27s
CI / docker (pull_request) Has been skipped
CI / e2e_tests (pull_request) Failing after 14m31s
CI / coverage (pull_request) Successful in 14m1s
CI / integration_tests (pull_request) Failing after 22m6s
CI / status-check (pull_request) Failing after 1s
CI / benchmark-regression (pull_request) Successful in 55m47s
to 6d2a649e4e
All checks were successful
CI / typecheck (pull_request) Successful in 1m1s
CI / security (pull_request) Successful in 56s
CI / build (pull_request) Successful in 19s
CI / lint (pull_request) Successful in 3m20s
CI / helm (pull_request) Successful in 23s
CI / quality (pull_request) Successful in 3m47s
CI / unit_tests (pull_request) Successful in 7m1s
CI / e2e_tests (pull_request) Successful in 19m22s
CI / docker (pull_request) Successful in 11s
CI / integration_tests (pull_request) Successful in 22m53s
CI / coverage (pull_request) Successful in 10m49s
CI / status-check (pull_request) Successful in 1s
CI / benchmark-publish (pull_request) Has been skipped
CI / benchmark-regression (pull_request) Successful in 56m5s
2026-04-05 02:39:51 +00:00
Compare
Author
Owner

🔒 Review claimed by reviewer-pool-1 [claim-token: reviewer-pool-1-2759-1775369400]


Automated by CleverAgents Bot
Supervisor: PR Review | Agent: ca-continuous-pr-reviewer

🔒 Review claimed by reviewer-pool-1 [claim-token: reviewer-pool-1-2759-1775369400] --- **Automated by CleverAgents Bot** Supervisor: PR Review | Agent: ca-continuous-pr-reviewer
freemo left a comment

Independent Review: Content Verified & Approved

Content Review

This is a docs-only PR adding documentation for two unreleased features referenced in the CHANGELOG. Both additions are accurate, well-structured, and correctly placed within the existing documentation hierarchy.

docs/reference/plan_cli.md — Warning admonition for legacy/v3 plan workflow mixing (#1577)

  • MkDocs !!! warning admonition syntax is correct
  • Content is clear and actionable: explains the detection/rejection behavior, what the user should do (migrate to v3), and references the source issue
  • Placement after the heading and before the Commands table is appropriate for a cross-cutting concern that affects all plan commands

docs/development/ci-cd.md — Pre-migrated database template section (#2334)

  • Section is logically placed between "Nox-Based CI" and "Quality Gates Summary"
  • Accurately documents _create_template_db(), CLEVERAGENTS_TEMPLATE_DB env var, and pabot usage
  • Lists all affected sessions correctly (unit_tests, integration_tests, slow_integration_tests, e2e_tests, coverage_report)
  • Technical details are consistent with the implementation

Commit Message

  • Follows Conventional Changelog format: docs: update plan CLI and CI/CD docs for unreleased features
  • Single atomic commit with descriptive body referencing both #1577 and #2334

Process Compliance

Check Status
Commit message format Conventional Changelog
Single atomic commit
Type/ label Type/Documentation
Milestone ⚠️ Not assigned (standalone docs PR — acceptable)
Closing keyword ⚠️ Not present (standalone docs PR documenting existing features — acceptable)

CI Status

All 14 CI checks passing on head commit 6d2a649:

  • lint , typecheck , security , quality
  • unit_tests , integration_tests , e2e_tests , coverage
  • build , docker , helm , benchmark-regression
  • benchmark-publish (skipped), status-check

Verdict

Documentation is accurate, well-written, and adds genuine value. No code changes, no risk. Content approved — attempting merge.

Note: Cannot post formal APPROVED review due to same-user constraint (PR author and reviewer share the same Forgejo account).


Automated by CleverAgents Bot
Supervisor: PR Review | Agent: ca-pr-self-reviewer

## Independent Review: Content Verified & Approved ✅ ### Content Review This is a docs-only PR adding documentation for two unreleased features referenced in the CHANGELOG. Both additions are accurate, well-structured, and correctly placed within the existing documentation hierarchy. **`docs/reference/plan_cli.md`** — Warning admonition for legacy/v3 plan workflow mixing (#1577) - MkDocs `!!! warning` admonition syntax is correct - Content is clear and actionable: explains the detection/rejection behavior, what the user should do (migrate to v3), and references the source issue - Placement after the heading and before the Commands table is appropriate for a cross-cutting concern that affects all plan commands **`docs/development/ci-cd.md`** — Pre-migrated database template section (#2334) - Section is logically placed between "Nox-Based CI" and "Quality Gates Summary" - Accurately documents `_create_template_db()`, `CLEVERAGENTS_TEMPLATE_DB` env var, and `pabot` usage - Lists all affected sessions correctly (`unit_tests`, `integration_tests`, `slow_integration_tests`, `e2e_tests`, `coverage_report`) - Technical details are consistent with the implementation ### Commit Message - Follows Conventional Changelog format: `docs: update plan CLI and CI/CD docs for unreleased features` ✅ - Single atomic commit with descriptive body referencing both #1577 and #2334 ✅ ### Process Compliance | Check | Status | |-------|--------| | Commit message format | ✅ Conventional Changelog | | Single atomic commit | ✅ | | `Type/` label | ✅ `Type/Documentation` | | Milestone | ⚠️ Not assigned (standalone docs PR — acceptable) | | Closing keyword | ⚠️ Not present (standalone docs PR documenting existing features — acceptable) | ### CI Status All 14 CI checks passing on head commit `6d2a649`: - lint ✅, typecheck ✅, security ✅, quality ✅ - unit_tests ✅, integration_tests ✅, e2e_tests ✅, coverage ✅ - build ✅, docker ✅, helm ✅, benchmark-regression ✅ - benchmark-publish ✅ (skipped), status-check ✅ ### Verdict Documentation is accurate, well-written, and adds genuine value. No code changes, no risk. Content approved — attempting merge. *Note: Cannot post formal APPROVED review due to same-user constraint (PR author and reviewer share the same Forgejo account).* --- **Automated by CleverAgents Bot** Supervisor: PR Review | Agent: ca-pr-self-reviewer
freemo force-pushed docs/unreleased-feature-docs from 6d2a649e4e
All checks were successful
CI / typecheck (pull_request) Successful in 1m1s
CI / security (pull_request) Successful in 56s
CI / build (pull_request) Successful in 19s
CI / lint (pull_request) Successful in 3m20s
CI / helm (pull_request) Successful in 23s
CI / quality (pull_request) Successful in 3m47s
CI / unit_tests (pull_request) Successful in 7m1s
CI / e2e_tests (pull_request) Successful in 19m22s
CI / docker (pull_request) Successful in 11s
CI / integration_tests (pull_request) Successful in 22m53s
CI / coverage (pull_request) Successful in 10m49s
CI / status-check (pull_request) Successful in 1s
CI / benchmark-publish (pull_request) Has been skipped
CI / benchmark-regression (pull_request) Successful in 56m5s
to af675e3229
Some checks are pending
CI / benchmark-publish (pull_request) Waiting to run
CI / lint (pull_request) Successful in 29s
CI / typecheck (pull_request) Successful in 50s
CI / security (pull_request) Successful in 57s
CI / quality (pull_request) Successful in 34s
CI / benchmark-regression (pull_request) Waiting to run
CI / build (pull_request) Successful in 19s
CI / helm (pull_request) Successful in 25s
CI / unit_tests (pull_request) Successful in 7m8s
CI / docker (pull_request) Successful in 1m22s
CI / e2e_tests (pull_request) Successful in 17m20s
CI / coverage (pull_request) Successful in 11m28s
CI / integration_tests (pull_request) Successful in 21m56s
CI / status-check (pull_request) Successful in 1s
2026-04-05 06:18:51 +00:00
Compare
freemo scheduled this pull request to auto merge when all checks succeed 2026-04-05 06:21:39 +00:00
Author
Owner

Merge Scheduled

PR reviewed and approved. Branch was rebased onto latest master (8c07994 → new HEAD af675e32) to satisfy the "branches must be up-to-date" branch protection rule.

Merge has been scheduled to execute automatically when all CI checks pass on the rebased commit. Since this is a docs-only change with identical content to the previously-passing commit, CI is expected to pass cleanly.

Merge strategy: merge (single commit PR)
Branch cleanup: Feature branch will be deleted after merge.


Automated by CleverAgents Bot
Supervisor: PR Review | Agent: ca-pr-self-reviewer

## Merge Scheduled ✅ PR reviewed and approved. Branch was rebased onto latest master (`8c07994` → new HEAD `af675e32`) to satisfy the "branches must be up-to-date" branch protection rule. Merge has been scheduled to execute automatically when all CI checks pass on the rebased commit. Since this is a docs-only change with identical content to the previously-passing commit, CI is expected to pass cleanly. **Merge strategy:** `merge` (single commit PR) **Branch cleanup:** Feature branch will be deleted after merge. --- **Automated by CleverAgents Bot** Supervisor: PR Review | Agent: ca-pr-self-reviewer
Author
Owner

🔒 Review claimed by reviewer-pool-1 [claim-token: reviewer-pool-1-2759-1775371600]


Automated by CleverAgents Bot
Supervisor: PR Review | Agent: ca-continuous-pr-reviewer

🔒 Review claimed by reviewer-pool-1 [claim-token: reviewer-pool-1-2759-1775371600] --- **Automated by CleverAgents Bot** Supervisor: PR Review | Agent: ca-continuous-pr-reviewer
freemo left a comment

Independent Review: Content Verified & Approved

Content Verification

This is a docs-only PR adding documentation for two unreleased features and updating the project timeline. All documentation claims have been independently verified against the codebase.

docs/reference/plan_cli.md — Warning admonition for legacy/v3 plan workflow mixing (#1577)

  • MkDocs !!! warning admonition syntax is correct
  • Placement after the heading and before the Commands table is appropriate
  • Content is clear, actionable, and references the source issue

docs/development/ci-cd.md — Pre-migrated database template section (#2334)

  • Verified _create_template_db() exists at noxfile.py line 69
  • Verified CLEVERAGENTS_TEMPLATE_DB env var is set in 5 nox sessions (lines 170-171, 264-265, 353-354, 437-438, 500-501)
  • Verified slow_integration_tests uses pabot (noxfile.py line 315-316)
  • Section is logically placed between "Nox-Based CI" and "Quality Gates Summary"

docs/timeline.md — Day 95 data corrections

  • Milestone completion percentages and open issue counts updated
  • Risk register, forecast tables, and task inventory aligned with corrected data
  • Note: these timeline changes are not mentioned in the PR body, but are consistent corrections to the tracking document

Process Compliance

Check Status
Commit message format Conventional Changelog: docs: update plan CLI and CI/CD docs for unreleased features
Single atomic commit
Type/ label Type/Documentation
Milestone ⚠️ Not assigned (standalone docs PR — acceptable)
Closing keyword ⚠️ Not present (standalone docs PR — acceptable)
needs feedback label Not present

CI Status (head commit af675e3)

All required checks passing:

  • lint , typecheck , security , quality
  • unit_tests , integration_tests , e2e_tests , coverage
  • build , docker , helm , status-check

Minor Observation (Non-blocking)

The PR body only describes the plan_cli.md and ci-cd.md changes but the diff also includes substantial timeline.md updates. For future PRs, the body should describe all files modified. This is not blocking since the timeline is a living tracking document.

Verdict

Documentation is accurate, well-written, and verified against the implementation. All CI checks pass. Content approved — attempting merge.

Note: Cannot post formal APPROVED review due to Forgejo same-user constraint (PR author and reviewer share the same account).


Automated by CleverAgents Bot
Supervisor: PR Review | Agent: ca-pr-self-reviewer

## Independent Review: Content Verified & Approved ✅ ### Content Verification This is a docs-only PR adding documentation for two unreleased features and updating the project timeline. All documentation claims have been independently verified against the codebase. **`docs/reference/plan_cli.md`** — Warning admonition for legacy/v3 plan workflow mixing (#1577) - MkDocs `!!! warning` admonition syntax is correct - Placement after the heading and before the Commands table is appropriate - Content is clear, actionable, and references the source issue **`docs/development/ci-cd.md`** — Pre-migrated database template section (#2334) - Verified `_create_template_db()` exists at noxfile.py line 69 ✅ - Verified `CLEVERAGENTS_TEMPLATE_DB` env var is set in 5 nox sessions (lines 170-171, 264-265, 353-354, 437-438, 500-501) ✅ - Verified `slow_integration_tests` uses `pabot` (noxfile.py line 315-316) ✅ - Section is logically placed between "Nox-Based CI" and "Quality Gates Summary" **`docs/timeline.md`** — Day 95 data corrections - Milestone completion percentages and open issue counts updated - Risk register, forecast tables, and task inventory aligned with corrected data - Note: these timeline changes are not mentioned in the PR body, but are consistent corrections to the tracking document ### Process Compliance | Check | Status | |-------|--------| | Commit message format | ✅ Conventional Changelog: `docs: update plan CLI and CI/CD docs for unreleased features` | | Single atomic commit | ✅ | | `Type/` label | ✅ `Type/Documentation` | | Milestone | ⚠️ Not assigned (standalone docs PR — acceptable) | | Closing keyword | ⚠️ Not present (standalone docs PR — acceptable) | | `needs feedback` label | ✅ Not present | ### CI Status (head commit `af675e3`) All required checks passing: - lint ✅, typecheck ✅, security ✅, quality ✅ - unit_tests ✅, integration_tests ✅, e2e_tests ✅, coverage ✅ - build ✅, docker ✅, helm ✅, status-check ✅ ### Minor Observation (Non-blocking) The PR body only describes the plan_cli.md and ci-cd.md changes but the diff also includes substantial timeline.md updates. For future PRs, the body should describe all files modified. This is not blocking since the timeline is a living tracking document. ### Verdict Documentation is accurate, well-written, and verified against the implementation. All CI checks pass. Content approved — attempting merge. *Note: Cannot post formal APPROVED review due to Forgejo same-user constraint (PR author and reviewer share the same account).* --- **Automated by CleverAgents Bot** Supervisor: PR Review | Agent: ca-pr-self-reviewer
freemo force-pushed docs/unreleased-feature-docs from af675e3229
Some checks are pending
CI / benchmark-publish (pull_request) Waiting to run
CI / lint (pull_request) Successful in 29s
CI / typecheck (pull_request) Successful in 50s
CI / security (pull_request) Successful in 57s
CI / quality (pull_request) Successful in 34s
CI / benchmark-regression (pull_request) Waiting to run
CI / build (pull_request) Successful in 19s
CI / helm (pull_request) Successful in 25s
CI / unit_tests (pull_request) Successful in 7m8s
CI / docker (pull_request) Successful in 1m22s
CI / e2e_tests (pull_request) Successful in 17m20s
CI / coverage (pull_request) Successful in 11m28s
CI / integration_tests (pull_request) Successful in 21m56s
CI / status-check (pull_request) Successful in 1s
to 36b3212607
All checks were successful
CI / typecheck (pull_request) Successful in 1m2s
CI / security (pull_request) Successful in 51s
CI / quality (pull_request) Successful in 46s
CI / lint (pull_request) Successful in 3m21s
CI / build (pull_request) Successful in 19s
CI / helm (pull_request) Successful in 23s
CI / unit_tests (pull_request) Successful in 7m6s
CI / e2e_tests (pull_request) Successful in 18m1s
CI / integration_tests (pull_request) Successful in 22m52s
CI / docker (pull_request) Successful in 21s
CI / coverage (pull_request) Successful in 10m58s
CI / status-check (pull_request) Successful in 1s
CI / benchmark-publish (pull_request) Has been skipped
CI / benchmark-regression (pull_request) Successful in 57m25s
2026-04-05 08:20:53 +00:00
Compare
freemo force-pushed docs/unreleased-feature-docs from 36b3212607
All checks were successful
CI / typecheck (pull_request) Successful in 1m2s
CI / security (pull_request) Successful in 51s
CI / quality (pull_request) Successful in 46s
CI / lint (pull_request) Successful in 3m21s
CI / build (pull_request) Successful in 19s
CI / helm (pull_request) Successful in 23s
CI / unit_tests (pull_request) Successful in 7m6s
CI / e2e_tests (pull_request) Successful in 18m1s
CI / integration_tests (pull_request) Successful in 22m52s
CI / docker (pull_request) Successful in 21s
CI / coverage (pull_request) Successful in 10m58s
CI / status-check (pull_request) Successful in 1s
CI / benchmark-publish (pull_request) Has been skipped
CI / benchmark-regression (pull_request) Successful in 57m25s
to 1b20e52ed9
All checks were successful
CI / lint (pull_request) Successful in 27s
CI / typecheck (pull_request) Successful in 50s
CI / security (pull_request) Successful in 1m2s
CI / quality (pull_request) Successful in 35s
CI / build (pull_request) Successful in 23s
CI / helm (pull_request) Successful in 24s
CI / unit_tests (pull_request) Successful in 6m50s
CI / e2e_tests (pull_request) Successful in 16m15s
CI / integration_tests (pull_request) Successful in 23m7s
CI / docker (pull_request) Successful in 1m23s
CI / coverage (pull_request) Successful in 11m15s
CI / status-check (pull_request) Successful in 1s
CI / benchmark-publish (pull_request) Has been skipped
CI / benchmark-regression (pull_request) Successful in 57m10s
2026-04-05 08:31:33 +00:00
Compare
Author
Owner

Rebase & Merge Scheduled

Branch was rebased onto latest master (1411adfe) to satisfy the "branches must be up-to-date" branch protection rule. During the rebase, the docs/timeline.md changes were dropped because they conflicted with PR #3080 (which was already merged to master with a more recent Day 95 timeline refresh). The remaining changes — docs/reference/plan_cli.md and docs/development/ci-cd.md — applied cleanly.

New head commit: 1b20e52e
Changes in rebased commit: 2 files (plan_cli.md + ci-cd.md), 20 insertions
Merge strategy: merge (single commit PR)
Merge scheduled: Will auto-merge when all CI checks pass on the rebased commit.
Branch cleanup: Feature branch will be deleted after merge.


Automated by CleverAgents Bot
Supervisor: PR Review | Agent: ca-pr-self-reviewer

## Rebase & Merge Scheduled ✅ Branch was rebased onto latest master (`1411adfe`) to satisfy the "branches must be up-to-date" branch protection rule. During the rebase, the `docs/timeline.md` changes were dropped because they conflicted with PR #3080 (which was already merged to master with a more recent Day 95 timeline refresh). The remaining changes — `docs/reference/plan_cli.md` and `docs/development/ci-cd.md` — applied cleanly. **New head commit:** `1b20e52e` **Changes in rebased commit:** 2 files (plan_cli.md + ci-cd.md), 20 insertions **Merge strategy:** `merge` (single commit PR) **Merge scheduled:** Will auto-merge when all CI checks pass on the rebased commit. **Branch cleanup:** Feature branch will be deleted after merge. --- **Automated by CleverAgents Bot** Supervisor: PR Review | Agent: ca-pr-self-reviewer
Author
Owner

🔒 Review claimed by reviewer-pool-1 [claim-token: reviewer-pool-1-2759-1743900000]


Automated by CleverAgents Bot
Supervisor: PR Review | Agent: ca-continuous-pr-reviewer

🔒 Review claimed by reviewer-pool-1 [claim-token: reviewer-pool-1-2759-1743900000] --- **Automated by CleverAgents Bot** Supervisor: PR Review | Agent: ca-continuous-pr-reviewer
freemo left a comment

Code Review — LGTM

PR: docs: update plan CLI and CI/CD docs for unreleased features

Review Checklist

Correctness: Updates docs/reference/plan_cli.md with !!! warning admonition for legacy/v3 plan workflow mixing detection. Updates CI/CD docs for unreleased features.

Commit Format: docs: follows Conventional Changelog format.

No code changes: Documentation-only PR.

Labels: Priority/Medium, Type/Documentation — correctly assigned.

Issues Noted (Non-blocking)

  • ⚠️ Missing milestone — Please assign to the appropriate milestone.

Decision: LGTM — Proceeding to merge when CI passes.


Automated by CleverAgents Bot
Supervisor: PR Review | Agent: ca-continuous-pr-reviewer

## Code Review — LGTM ✅ **PR:** docs: update plan CLI and CI/CD docs for unreleased features ### Review Checklist **✅ Correctness:** Updates `docs/reference/plan_cli.md` with `!!! warning` admonition for legacy/v3 plan workflow mixing detection. Updates CI/CD docs for unreleased features. **✅ Commit Format:** `docs:` follows Conventional Changelog format. **✅ No code changes:** Documentation-only PR. **✅ Labels:** `Priority/Medium`, `Type/Documentation` — correctly assigned. ### Issues Noted (Non-blocking) - ⚠️ **Missing milestone** — Please assign to the appropriate milestone. ### Decision: **LGTM** — Proceeding to merge when CI passes. --- **Automated by CleverAgents Bot** Supervisor: PR Review | Agent: ca-continuous-pr-reviewer
HAL9000 approved these changes 2026-04-08 17:55:20 +00:00
HAL9000 left a comment

Independent Code Review — APPROVED

Review focus areas: api-consistency, naming-conventions, code-patterns
Review reason: stale-review (>24h since last review)
Review context: 5 prior review passes (all COMMENT state due to same-user constraint), all content-approved


Content Review

This is a docs-only PR (P3 per the project's Review Priority Matrix) adding/improving documentation for two unreleased features. Both changes have been independently verified against the codebase by prior reviewers.

docs/reference/plan_cli.md — Admonition for legacy/v3 plan workflow mixing (#1577)

  • Format change: Replaces a markdown blockquote (> **Note (v3.8.0+):**) with an MkDocs !!! warning admonition — this is a good improvement for MkDocs rendering consistency
  • Syntax: !!! warning "Legacy/v3 Plan Workflow Mixing" is correct MkDocs admonition syntax with proper 4-space indentation
  • Issue reference: Added (#1577) for traceability
  • Content accuracy: Correctly describes the detection/rejection behavior and migration guidance

docs/development/ci-cd.md — Pre-Migrated Database Template section (#2334)

  • Placement: Correctly inserted between "Nox-Based CI" and "Quality Gates Summary" sections
  • Naming conventions: _create_template_db() (private function prefix), CLEVERAGENTS_TEMPLATE_DB (project env var prefix pattern) — both consistent with project conventions
  • API consistency: Nox session names (unit_tests, integration_tests, slow_integration_tests, e2e_tests, coverage_report) match the session names documented elsewhere in the same file
  • Technical accuracy: pabot correctly identified as parallel Robot Framework runner
  • Code patterns: Section follows the same heading hierarchy and prose style as surrounding sections

Focus Area Deep Dive

API Consistency

  • All referenced nox sessions, environment variables, and function names are consistent with the existing documentation and codebase
  • The CLEVERAGENTS_TEMPLATE_DB env var follows the established CLEVERAGENTS_* prefix pattern used by other project env vars

Naming Conventions

  • Documentation uses consistent naming: snake_case for nox sessions, SCREAMING_SNAKE_CASE for env vars, underscore-prefixed for private functions
  • No naming inconsistencies detected between the new content and existing documentation

Code Patterns

  • The !!! warning admonition is the correct MkDocs pattern for important user-facing notices
  • The new ci-cd.md section follows the established pattern: heading → prose description → technical details → issue reference

Process Compliance

Check Status
Commit message format Conventional Changelog: docs: update plan CLI and CI/CD docs for unreleased features
Type/ label Type/Documentation
Milestone ⚠️ Not assigned (standalone docs PR — acceptable per prior reviews)
Closing keyword ⚠️ Not present (standalone docs PR documenting existing features — acceptable)
No code changes Documentation only

Minor Suggestions (Non-blocking)

  1. Version context removed: The master version includes (v3.8.0+) in the plan_cli.md note, which tells users when this behavior was introduced. The admonition version drops this. Consider preserving it, e.g.: !!! warning "Legacy/v3 Plan Workflow Mixing (v3.8.0+)" — useful for users on older versions.

  2. Slight wording ambiguity: The admonition says "Migrate all plan workflows to v3 before mixing commands in a single session." The phrase "before mixing" could be read as "in order to mix." The master version's phrasing "Migrate fully to the v3 plan workflow before using agents plan" is slightly clearer. Consider: "Migrate all plan workflows to v3 to avoid this error."

Operational Note

⚠️ Branch is behind master (mergeable: false). The branch's ci-cd.md is missing substantial content added to master since the branch was created (Repository Push Authentication section, push-validation job, additional CI secrets). A rebase is required before merge, and the "Pre-Migrated Database Template" section insertion point may need adjustment relative to the new master content. This is an operational concern for the implementation workers — not a content quality blocker.

Verdict

Documentation content is accurate, well-written, and follows project conventions. All focus areas (api-consistency, naming-conventions, code-patterns) pass. Approved — pending rebase onto current master.


Automated by CleverAgents Bot
Supervisor: PR Review | Agent: pr-self-reviewer

## Independent Code Review — APPROVED ✅ **Review focus areas:** api-consistency, naming-conventions, code-patterns **Review reason:** stale-review (>24h since last review) **Review context:** 5 prior review passes (all COMMENT state due to same-user constraint), all content-approved --- ### Content Review This is a docs-only PR (P3 per the project's Review Priority Matrix) adding/improving documentation for two unreleased features. Both changes have been independently verified against the codebase by prior reviewers. #### `docs/reference/plan_cli.md` — Admonition for legacy/v3 plan workflow mixing (#1577) - **Format change**: Replaces a markdown blockquote (`> **Note (v3.8.0+):**`) with an MkDocs `!!! warning` admonition — this is a **good improvement** for MkDocs rendering consistency - **Syntax**: `!!! warning "Legacy/v3 Plan Workflow Mixing"` is correct MkDocs admonition syntax with proper 4-space indentation ✅ - **Issue reference**: Added `(#1577)` for traceability ✅ - **Content accuracy**: Correctly describes the detection/rejection behavior and migration guidance ✅ #### `docs/development/ci-cd.md` — Pre-Migrated Database Template section (#2334) - **Placement**: Correctly inserted between "Nox-Based CI" and "Quality Gates Summary" sections ✅ - **Naming conventions**: `_create_template_db()` (private function prefix), `CLEVERAGENTS_TEMPLATE_DB` (project env var prefix pattern) — both consistent with project conventions ✅ - **API consistency**: Nox session names (`unit_tests`, `integration_tests`, `slow_integration_tests`, `e2e_tests`, `coverage_report`) match the session names documented elsewhere in the same file ✅ - **Technical accuracy**: `pabot` correctly identified as parallel Robot Framework runner ✅ - **Code patterns**: Section follows the same heading hierarchy and prose style as surrounding sections ✅ ### Focus Area Deep Dive **API Consistency** ✅ - All referenced nox sessions, environment variables, and function names are consistent with the existing documentation and codebase - The `CLEVERAGENTS_TEMPLATE_DB` env var follows the established `CLEVERAGENTS_*` prefix pattern used by other project env vars **Naming Conventions** ✅ - Documentation uses consistent naming: snake_case for nox sessions, SCREAMING_SNAKE_CASE for env vars, underscore-prefixed for private functions - No naming inconsistencies detected between the new content and existing documentation **Code Patterns** ✅ - The `!!! warning` admonition is the correct MkDocs pattern for important user-facing notices - The new ci-cd.md section follows the established pattern: heading → prose description → technical details → issue reference ### Process Compliance | Check | Status | |-------|--------| | Commit message format | ✅ Conventional Changelog: `docs: update plan CLI and CI/CD docs for unreleased features` | | `Type/` label | ✅ `Type/Documentation` | | Milestone | ⚠️ Not assigned (standalone docs PR — acceptable per prior reviews) | | Closing keyword | ⚠️ Not present (standalone docs PR documenting existing features — acceptable) | | No code changes | ✅ Documentation only | ### Minor Suggestions (Non-blocking) 1. **Version context removed**: The master version includes `(v3.8.0+)` in the plan_cli.md note, which tells users when this behavior was introduced. The admonition version drops this. Consider preserving it, e.g.: `!!! warning "Legacy/v3 Plan Workflow Mixing (v3.8.0+)"` — useful for users on older versions. 2. **Slight wording ambiguity**: The admonition says "Migrate all plan workflows to v3 before mixing commands in a single session." The phrase "before mixing" could be read as "in order to mix." The master version's phrasing "Migrate fully to the v3 plan workflow before using `agents plan`" is slightly clearer. Consider: "Migrate all plan workflows to v3 to avoid this error." ### Operational Note ⚠️ **Branch is behind master** (`mergeable: false`). The branch's `ci-cd.md` is missing substantial content added to master since the branch was created (Repository Push Authentication section, push-validation job, additional CI secrets). A rebase is required before merge, and the "Pre-Migrated Database Template" section insertion point may need adjustment relative to the new master content. This is an operational concern for the implementation workers — not a content quality blocker. ### Verdict Documentation content is accurate, well-written, and follows project conventions. All focus areas (api-consistency, naming-conventions, code-patterns) pass. **Approved** — pending rebase onto current master. --- **Automated by CleverAgents Bot** Supervisor: PR Review | Agent: pr-self-reviewer
freemo closed this pull request 2026-04-15 15:44:31 +00:00
All checks were successful
CI / lint (pull_request) Successful in 27s
Required
Details
CI / typecheck (pull_request) Successful in 50s
Required
Details
CI / security (pull_request) Successful in 1m2s
Required
Details
CI / quality (pull_request) Successful in 35s
Required
Details
CI / build (pull_request) Successful in 23s
Required
Details
CI / helm (pull_request) Successful in 24s
CI / unit_tests (pull_request) Successful in 6m50s
Required
Details
CI / e2e_tests (pull_request) Successful in 16m15s
CI / integration_tests (pull_request) Successful in 23m7s
Required
Details
CI / docker (pull_request) Successful in 1m23s
Required
Details
CI / coverage (pull_request) Successful in 11m15s
Required
Details
CI / status-check (pull_request) Successful in 1s
CI / benchmark-publish (pull_request) Has been skipped
CI / benchmark-regression (pull_request) Successful in 57m10s

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!2759
No description provided.