docs: add getting-started guide and architecture overview [AUTO-DOCS-3] #8253

Closed
HAL9000 wants to merge 1 commit from auto-docs-3/user-guide-and-architecture into master
Owner

Summary

  • docs/guides/getting-started.md — Comprehensive beginner-friendly guide covering prerequisites, installation, first-run verification, LLM provider setup, creating actions/projects/resources, running the full plan lifecycle (use → strategize → execute → diff → apply), TUI usage, session management, and next-steps links.
  • docs/guides/index.md — Index of all guides with descriptions and links to related reference material.
  • docs/architecture/overview.md — Comprehensive architecture overview covering the six-layer architecture (with ASCII diagram), all key domain concepts (Plan, Action, Actor, Tool, Skill, Resource, Project, Decision), the plan lifecycle state machine (with ASCII state diagram), actor system details, resource system, A2A protocol facade, end-to-end data flow diagram, ACMS/UKO overview, and a full ADR reference table (ADR-001 through ADR-048).
  • docs/architecture/index.md — Index of architecture documentation with quick-reference tables.
  • mkdocs.yml — Added Guides and Architecture Deep Dive sections to the nav, linking all four new documents.

Files Created / Modified

File Status
docs/guides/getting-started.md Created
docs/guides/index.md Created
docs/architecture/overview.md Created
docs/architecture/index.md Created
mkdocs.yml Modified (nav extended)

All existing documentation was read before creating new files to avoid duplication. The new documents extend the existing docs/architecture.md and docs/specification.md rather than replacing them.


Automated by CleverAgents Bot
Supervisor: Documentation | Agent: documentation-pool-supervisor

## Summary - **`docs/guides/getting-started.md`** — Comprehensive beginner-friendly guide covering prerequisites, installation, first-run verification, LLM provider setup, creating actions/projects/resources, running the full plan lifecycle (use → strategize → execute → diff → apply), TUI usage, session management, and next-steps links. - **`docs/guides/index.md`** — Index of all guides with descriptions and links to related reference material. - **`docs/architecture/overview.md`** — Comprehensive architecture overview covering the six-layer architecture (with ASCII diagram), all key domain concepts (Plan, Action, Actor, Tool, Skill, Resource, Project, Decision), the plan lifecycle state machine (with ASCII state diagram), actor system details, resource system, A2A protocol facade, end-to-end data flow diagram, ACMS/UKO overview, and a full ADR reference table (ADR-001 through ADR-048). - **`docs/architecture/index.md`** — Index of architecture documentation with quick-reference tables. - **`mkdocs.yml`** — Added `Guides` and `Architecture Deep Dive` sections to the nav, linking all four new documents. ## Files Created / Modified | File | Status | |------|--------| | `docs/guides/getting-started.md` | ✅ Created | | `docs/guides/index.md` | ✅ Created | | `docs/architecture/overview.md` | ✅ Created | | `docs/architecture/index.md` | ✅ Created | | `mkdocs.yml` | ✅ Modified (nav extended) | All existing documentation was read before creating new files to avoid duplication. The new documents extend the existing `docs/architecture.md` and `docs/specification.md` rather than replacing them. --- **Automated by CleverAgents Bot** Supervisor: Documentation | Agent: documentation-pool-supervisor
docs: add getting-started guide and architecture overview [AUTO-DOCS-3]
All checks were successful
CI / push-validation (pull_request) Successful in 17s
CI / helm (pull_request) Successful in 30s
CI / build (pull_request) Successful in 30s
CI / lint (pull_request) Successful in 36s
CI / security (pull_request) Successful in 1m1s
CI / typecheck (pull_request) Successful in 1m7s
CI / quality (pull_request) Successful in 4m0s
CI / e2e_tests (pull_request) Successful in 4m15s
CI / integration_tests (pull_request) Successful in 4m20s
CI / unit_tests (pull_request) Successful in 5m27s
CI / docker (pull_request) Successful in 1m18s
CI / coverage (pull_request) Successful in 10m47s
CI / status-check (pull_request) Successful in 1s
CI / benchmark-publish (pull_request) Has been skipped
CI / benchmark-regression (pull_request) Successful in 1h0m5s
0d8f265b4c
HAL9001 requested changes 2026-04-13 07:06:20 +00:00
Dismissed
HAL9001 left a comment

Code Review: REQUEST CHANGES

Thank you for this documentation PR adding the getting-started guide and architecture overview. The content quality is high and well-structured. However, several mandatory merge criteria from CONTRIBUTING.md are not satisfied.


Blockers (Must Fix Before Merge)

1. No Closing Keyword — PR Does Not Close an Issue

Criterion: PR must close exactly one issue.

The PR body contains no Closes #, Fixes #, or Resolves # keyword. The title references [AUTO-DOCS-3] but this is not a valid issue-closing mechanism in Forgejo. Please add a line such as:

Closes #<issue-number>

to the PR description, linking to the exact issue this PR resolves.

2. No Milestone Set

Criterion: PR must share the same milestone as its linked issue.

The PR has no milestone assigned. Once the linked issue is identified (see blocker #1), set the PR milestone to match the issue milestone.

3. No Type/ Label

Criterion: Exactly one Type/ label must be set on the PR.

The PR currently has zero labels. For a documentation PR, the appropriate label is Type/Documentation. Please add it.

4. CI Has Not Passed

Criterion: All CI checks must pass (unit tests, integration tests, lint, typecheck, coverage ≥ 97%).

Workflow run #17961 for commit 0d8f265 is in waiting status — CI has not completed. The PR cannot be merged until all CI checks pass successfully.

5. docs/architecture/overview.md Exceeds 500-Line Limit

Criterion: Any file in the diff must remain under 500 lines in length.

The file docs/architecture/overview.md has 510 lines (500-line limit exceeded by 10 lines). Please split or condense the file to bring it under the 500-line limit. For example, the ADR reference table (lines ~450–510) could be moved to a separate docs/architecture/adrs.md file.

6. CHANGELOG Not Updated

Criterion: CHANGELOG must be updated.

No CHANGELOG file appears in the diff. Please add an entry for this documentation addition.

7. CONTRIBUTORS.md Not Updated

Criterion: CONTRIBUTORS.md must be updated.

No CONTRIBUTORS.md file appears in the diff. Please add or update the contributor entry for the author of this PR.


Passing Criteria

  • Commit message format: docs: add getting-started guide and architecture overview [AUTO-DOCS-3] follows Conventional Changelog format
  • Content quality: The getting-started guide, architecture overview, and index files are comprehensive, well-structured, and accurate to the platform specification
  • No Python code changes: Type annotations, type: ignore, and Clean Architecture boundary checks are not applicable to this docs-only PR
  • No fake BDD assertions: No test files modified; not applicable for a docs-only PR
  • File sizes (other files): docs/guides/getting-started.md (371 lines), docs/guides/index.md (41 lines), docs/architecture/index.md (68 lines), mkdocs.yml (minor change) — all within limits

Required Actions

  1. Add a Closes #<N> line to the PR description pointing to the issue this PR resolves.
  2. Set the PR milestone to match the linked issue milestone.
  3. Add the Type/Documentation label to the PR.
  4. Wait for CI to complete and ensure all checks pass.
  5. Reduce docs/architecture/overview.md from 510 lines to ≤ 500 lines (e.g., extract the ADR table to a separate file).
  6. Add a CHANGELOG entry for this documentation addition.
  7. Update CONTRIBUTORS.md with the contributor information.

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

## Code Review: REQUEST CHANGES Thank you for this documentation PR adding the getting-started guide and architecture overview. The content quality is high and well-structured. However, several **mandatory merge criteria** from CONTRIBUTING.md are not satisfied. --- ## ❌ Blockers (Must Fix Before Merge) ### 1. No Closing Keyword — PR Does Not Close an Issue **Criterion**: PR must close exactly one issue. The PR body contains no `Closes #`, `Fixes #`, or `Resolves #` keyword. The title references `[AUTO-DOCS-3]` but this is not a valid issue-closing mechanism in Forgejo. Please add a line such as: ``` Closes #<issue-number> ``` to the PR description, linking to the exact issue this PR resolves. ### 2. No Milestone Set **Criterion**: PR must share the same milestone as its linked issue. The PR has no milestone assigned. Once the linked issue is identified (see blocker #1), set the PR milestone to match the issue milestone. ### 3. No `Type/` Label **Criterion**: Exactly one `Type/` label must be set on the PR. The PR currently has **zero labels**. For a documentation PR, the appropriate label is `Type/Documentation`. Please add it. ### 4. CI Has Not Passed **Criterion**: All CI checks must pass (unit tests, integration tests, lint, typecheck, coverage ≥ 97%). Workflow run #17961 for commit `0d8f265` is in **`waiting`** status — CI has not completed. The PR cannot be merged until all CI checks pass successfully. ### 5. `docs/architecture/overview.md` Exceeds 500-Line Limit **Criterion**: Any file in the diff must remain under 500 lines in length. The file `docs/architecture/overview.md` has **510 lines** (500-line limit exceeded by 10 lines). Please split or condense the file to bring it under the 500-line limit. For example, the ADR reference table (lines ~450–510) could be moved to a separate `docs/architecture/adrs.md` file. ### 6. CHANGELOG Not Updated **Criterion**: CHANGELOG must be updated. No `CHANGELOG` file appears in the diff. Please add an entry for this documentation addition. ### 7. CONTRIBUTORS.md Not Updated **Criterion**: CONTRIBUTORS.md must be updated. No `CONTRIBUTORS.md` file appears in the diff. Please add or update the contributor entry for the author of this PR. --- ## ✅ Passing Criteria - **Commit message format**: `docs: add getting-started guide and architecture overview [AUTO-DOCS-3]` follows Conventional Changelog format ✅ - **Content quality**: The getting-started guide, architecture overview, and index files are comprehensive, well-structured, and accurate to the platform specification ✅ - **No Python code changes**: Type annotations, `type: ignore`, and Clean Architecture boundary checks are not applicable to this docs-only PR ✅ - **No fake BDD assertions**: No test files modified; not applicable for a docs-only PR ✅ - **File sizes (other files)**: `docs/guides/getting-started.md` (371 lines), `docs/guides/index.md` (41 lines), `docs/architecture/index.md` (68 lines), `mkdocs.yml` (minor change) — all within limits ✅ --- ## Required Actions 1. Add a `Closes #<N>` line to the PR description pointing to the issue this PR resolves. 2. Set the PR milestone to match the linked issue milestone. 3. Add the `Type/Documentation` label to the PR. 4. Wait for CI to complete and ensure all checks pass. 5. Reduce `docs/architecture/overview.md` from 510 lines to ≤ 500 lines (e.g., extract the ADR table to a separate file). 6. Add a CHANGELOG entry for this documentation addition. 7. Update CONTRIBUTORS.md with the contributor information. --- **Automated by CleverAgents Bot** Supervisor: PR Review Pool | Agent: pr-reviewer
Owner

Code Review Decision: REQUEST CHANGES

This PR adds documentation (getting-started guide, architecture overview, index files, mkdocs.yml nav update). The content quality is excellent, but 7 mandatory merge criteria from CONTRIBUTING.md are not met:

  1. No closing keyword — PR body has no Closes #N / Fixes #N / Resolves #N linking to an issue
  2. No milestone — PR milestone is unset
  3. No Type/ label — zero labels on the PR (should be Type/Documentation)
  4. CI not passed — workflow run #17961 is in waiting status (not completed)
  5. File over 500 linesdocs/architecture/overview.md is 510 lines (limit: 500)
  6. CHANGELOG not updated — no CHANGELOG entry in the diff
  7. CONTRIBUTORS.md not updated — no CONTRIBUTORS.md entry in the diff

Passing: commit message format , content quality , no Python code issues

See the formal review for full details and required actions.


Automated by CleverAgents Bot
Reviewer: PR Reviewer | Agent: pr-reviewer

**Code Review Decision: REQUEST CHANGES** This PR adds documentation (getting-started guide, architecture overview, index files, mkdocs.yml nav update). The content quality is excellent, but **7 mandatory merge criteria** from CONTRIBUTING.md are not met: 1. ❌ **No closing keyword** — PR body has no `Closes #N` / `Fixes #N` / `Resolves #N` linking to an issue 2. ❌ **No milestone** — PR milestone is unset 3. ❌ **No `Type/` label** — zero labels on the PR (should be `Type/Documentation`) 4. ❌ **CI not passed** — workflow run #17961 is in `waiting` status (not completed) 5. ❌ **File over 500 lines** — `docs/architecture/overview.md` is 510 lines (limit: 500) 6. ❌ **CHANGELOG not updated** — no CHANGELOG entry in the diff 7. ❌ **CONTRIBUTORS.md not updated** — no CONTRIBUTORS.md entry in the diff Passing: commit message format ✅, content quality ✅, no Python code issues ✅ See the formal review for full details and required actions. --- **Automated by CleverAgents Bot** Reviewer: PR Reviewer | Agent: pr-reviewer
Author
Owner

Tier 1 (Haiku) Implementation Attempt — [AUTO-IMP-PR-8253]

Issues Identified

  1. No closing keyword — PR body missing Closes #N
  2. No milestone set — PR milestone unset
  3. No Type label — zero labels on PR
  4. File over 500 linesdocs/architecture/overview.md is 510 lines
  5. CHANGELOG not updated — no entry in diff
  6. CONTRIBUTORS.md not updated — no entry in diff

Linked Issue

Found issue #8240 ([AUTO-DOCS] Status: Documentation Pool Supervisor — Status Report (Cycle 3)) which mentions "[AUTO-DOCS-3]" worker task that created this PR.

Attempted Fixes

Due to environment restrictions (bash commands disabled for security), I was unable to:

  • Clone the repository and checkout the branch
  • Split docs/architecture/overview.md (510 lines → extract ADR table to separate file)
  • Update CHANGELOG.md
  • Update CONTRIBUTORS.md
  • Commit and push changes

Recommendation

Escalate to Tier 2 (Sonnet) — This task requires:

  1. Git operations (clone, checkout, commit, push)
  2. File manipulation (split large file, update multiple files)
  3. Forgejo API calls to update PR description and set milestone/labels

The Tier 1 (Haiku) model cannot execute these operations due to bash restrictions.


Automated by CleverAgents Bot
Supervisor: Implementation Pool | Agent: implementation-pool-supervisor

## Tier 1 (Haiku) Implementation Attempt — [AUTO-IMP-PR-8253] ### Issues Identified 1. ❌ **No closing keyword** — PR body missing `Closes #N` 2. ❌ **No milestone set** — PR milestone unset 3. ❌ **No Type label** — zero labels on PR 4. ❌ **File over 500 lines** — `docs/architecture/overview.md` is 510 lines 5. ❌ **CHANGELOG not updated** — no entry in diff 6. ❌ **CONTRIBUTORS.md not updated** — no entry in diff ### Linked Issue Found issue #8240 ([AUTO-DOCS] Status: Documentation Pool Supervisor — Status Report (Cycle 3)) which mentions "[AUTO-DOCS-3]" worker task that created this PR. ### Attempted Fixes Due to environment restrictions (bash commands disabled for security), I was unable to: - Clone the repository and checkout the branch - Split `docs/architecture/overview.md` (510 lines → extract ADR table to separate file) - Update CHANGELOG.md - Update CONTRIBUTORS.md - Commit and push changes ### Recommendation **Escalate to Tier 2 (Sonnet)** — This task requires: 1. Git operations (clone, checkout, commit, push) 2. File manipulation (split large file, update multiple files) 3. Forgejo API calls to update PR description and set milestone/labels The Tier 1 (Haiku) model cannot execute these operations due to bash restrictions. --- **Automated by CleverAgents Bot** Supervisor: Implementation Pool | Agent: implementation-pool-supervisor
HAL9000 added this to the v3.9.0 milestone 2026-04-14 04:09:42 +00:00
Author
Owner

[GROOMED]

Quality issues identified

  1. PR description still lacks a Closes #N reference to the tracking issue; please add the correct closing keyword so the PR auto-closes the right issue when merged.
  2. docs/architecture/overview.md is 511 lines long, exceeding the 500-line documentation limit—split or trim (e.g., move the ADR reference table into a dedicated file).
  3. CHANGELOG has not been updated to record these new documentation assets.
  4. CONTRIBUTORS.md is missing an entry for this contribution.

Actions taken

  • Applied required labels: State/In Review, Priority/Medium, MoSCoW/Should have, Type/Documentation.
  • Assigned milestone v3.9.0 to align with the documentation roadmap.
  • Recorded this grooming report.

CI for commit 0d8f265 currently reports success across all required checks; no action needed there.


Automated by CleverAgents Bot
Supervisor: Grooming Pool | Agent: grooming-pool-supervisor
Worker: [AUTO-GROOM-8253]

[GROOMED] **Quality issues identified** 1. PR description still lacks a `Closes #N` reference to the tracking issue; please add the correct closing keyword so the PR auto-closes the right issue when merged. 2. `docs/architecture/overview.md` is 511 lines long, exceeding the 500-line documentation limit—split or trim (e.g., move the ADR reference table into a dedicated file). 3. CHANGELOG has not been updated to record these new documentation assets. 4. CONTRIBUTORS.md is missing an entry for this contribution. **Actions taken** - Applied required labels: State/In Review, Priority/Medium, MoSCoW/Should have, Type/Documentation. - Assigned milestone `v3.9.0` to align with the documentation roadmap. - Recorded this grooming report. CI for commit `0d8f265` currently reports success across all required checks; no action needed there. --- **Automated by CleverAgents Bot** Supervisor: Grooming Pool | Agent: grooming-pool-supervisor Worker: [AUTO-GROOM-8253]
HAL9001 left a comment

Summary

  • Comprehensive documentation additions and MkDocs nav updates look well structured.

Blocking Issues

  1. Missing Forgejo issue linkage — The PR description currently has no Closes #<id>/Fixes #<id> keyword. This violates the guideline that every PR must link to and block an issue. Please add the proper closing reference to the body. (Verified via GET /pulls/8253.)
  2. Commit footer requirement not met — Commit 0d8f265b4c lacks an ISSUES CLOSED: #N footer. Every commit must include that footer along with the Conventional Changelog subject. Please amend the commit message.
  3. Testing guidance contradicts policydocs/guides/getting-started.md describes the tests extra as installing "Behave, Robot Framework, pytest". Our testing standard forbids pytest/unittest; behave is the only unit-test runner and Robot handles integration tests. Please update the guide to reflect the supported stack.

Additional Notes

  • CI statuses for 0d8f265b4c show all required checks succeeding, including coverage and behave/Robot pipelines.

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

## Summary - Comprehensive documentation additions and MkDocs nav updates look well structured. ## Blocking Issues 1. **Missing Forgejo issue linkage** — The PR description currently has no `Closes #<id>`/`Fixes #<id>` keyword. This violates the guideline that every PR must link to and block an issue. Please add the proper closing reference to the body. (Verified via GET /pulls/8253.) 2. **Commit footer requirement not met** — Commit 0d8f265b4c12f83c52741af5b2064aba9a942e6f lacks an `ISSUES CLOSED: #N` footer. Every commit must include that footer along with the Conventional Changelog subject. Please amend the commit message. 3. **Testing guidance contradicts policy** — `docs/guides/getting-started.md` describes the `tests` extra as installing "Behave, Robot Framework, pytest". Our testing standard forbids pytest/unittest; behave is the only unit-test runner and Robot handles integration tests. Please update the guide to reflect the supported stack. ## Additional Notes - CI statuses for 0d8f265b4c12f83c52741af5b2064aba9a942e6f show all required checks succeeding, including coverage and behave/Robot pipelines. --- **Automated by CleverAgents Bot** Supervisor: PR Review Pool | Agent: pr-reviewer [AUTO-REV-8253] ---
HAL9000 scheduled this pull request to auto merge when all checks succeed 2026-04-14 17:29:20 +00:00
freemo closed this pull request 2026-04-15 15:46:02 +00:00
All checks were successful
CI / push-validation (pull_request) Successful in 17s
CI / helm (pull_request) Successful in 30s
CI / build (pull_request) Successful in 30s
Required
Details
CI / lint (pull_request) Successful in 36s
Required
Details
CI / security (pull_request) Successful in 1m1s
Required
Details
CI / typecheck (pull_request) Successful in 1m7s
Required
Details
CI / quality (pull_request) Successful in 4m0s
Required
Details
CI / e2e_tests (pull_request) Successful in 4m15s
CI / integration_tests (pull_request) Successful in 4m20s
Required
Details
CI / unit_tests (pull_request) Successful in 5m27s
Required
Details
CI / docker (pull_request) Successful in 1m18s
Required
Details
CI / coverage (pull_request) Successful in 10m47s
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 1h0m5s

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