Skip to content

docs: acknowledge v3 multi-agent setup in README - #141

Merged
aram-devdocs merged 3 commits into
mainfrom
test/issue-140-readme-v3-comment
Apr 29, 2026
Merged

docs: acknowledge v3 multi-agent setup in README#141
aram-devdocs merged 3 commits into
mainfrom
test/issue-140-readme-v3-comment

Conversation

@aram-devdocs

@aram-devdocs aram-devdocs commented Apr 29, 2026

Copy link
Copy Markdown
Owner

Spec

Fixes #140

Summary

  • Adds a single visible italic line under the title block in README.md noting that the aram-ai-global v3 multi-agent stack drives PRs end-to-end.
  • The line is visible markdown rather than a hidden HTML comment, so the acknowledgment is discoverable to README readers (review feedback).

History note

This branch originally landed two cancelling commits (e326580, ca3d9c9) that left it as a net no-op, and the first commit used a test: type for a README edit. A history rewrite was not used because the destructive-reset path is blocked by a local pre-tool guard hook on this checkout. Instead, a corrective commit (7d705a4 docs: acknowledge v3 multi-agent setup in README) was added on top. Because this PR is squash-merged, the final commit on main will be a single docs: change with no trace of the no-op pair.

Test plan

  • PR diff is README.md only (+2 lines) — verified locally
  • git diff --check passes (no whitespace errors)
  • grep confirms the acknowledgment line is present in README.md
  • just check / just test / just determinism-check / cargo deny check — not run; README-only prose change with no code or docs/src/** impact
  • Humanizer skill — not applicable; no docs/src/** prose touched, and the added line avoids the project's anti-AI-tell vocabulary

Breaking change?

  • No

Anything reviewers should double-check

  • Placement: the line sits after the badges and before the bold tagline, which keeps the H1 + badge cluster intact while making the v3 acknowledgment visible to anyone reading the README top-down.

@github-actions

github-actions Bot commented Apr 29, 2026

Copy link
Copy Markdown
Contributor

Review: docs: acknowledge v3 multi-agent setup in README

Scope: README.md only (+2 lines). No Rust source, no tests, no docs/src/, no Cargo.toml, no CI files touched.


1. Determinism invariants

No code changed. Not applicable.

2. Workspace layering

No code changed. Not applicable.

3. Error handling

No code changed. Not applicable.

4. Test coverage

No new public API surface. Not applicable.

5. Documentation

The addition is a single blockquote placed between the badge row and the product tagline:

> _PRs in this repo are driven end-to-end by the aram-ai-global v3 multi-agent stack._

Checked against the anti-AI-writing list (documentation.md): none of the banned phrases ("dive in", "leverage", "seamless", "comprehensive", etc.) appear. The sentence is factual and specific.

docs/src/** is not touched, so the humanizer gate does not formally apply. Informally, the line is clean.

Placement note: The blockquote sits between the CI/license badges and the bold product tagline. This is a common README convention for a top-level process or status note. No structural issue.


Punch list

No blockers. No warnings.


Verdict: APPROVE

@aram-devdocs aram-devdocs changed the title test: acknowledge v3 multi-agent setup in README chore: remove README metadata comment Apr 29, 2026
@github-actions github-actions Bot mentioned this pull request Apr 29, 2026
2 tasks
Closes #140 by adding a single visible line under the title block
noting that the aram-ai-global v3 multi-agent stack drives PRs
end-to-end.

This is a corrective commit on top of an earlier add/remove no-op
pair (e326580 + ca3d9c9). The PR squash-merges, so the final commit
on main is this single docs change.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@aram-devdocs aram-devdocs changed the title chore: remove README metadata comment docs: acknowledge v3 multi-agent setup in README Apr 29, 2026
@aram-devdocs
aram-devdocs merged commit 1adf039 into main Apr 29, 2026
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

test: add a comment line to README acknowledging v3 multi-agent setup

1 participant