Skip to content

docs(#1934): make the positioning sentence exact in the harness docs - #1935

Closed
me2resh wants to merge 1 commit into
devfrom
feature/GH-1934-harness-readme-wording
Closed

me2resh wants to merge 1 commit into
devfrom
feature/GH-1934-harness-readme-wording

Conversation

@me2resh

@me2resh me2resh commented Oct 31, 2026

Copy link
Copy Markdown
Owner

Summary

  • Exact positioning sentence: both positioning passages in docs/harnesses/README.md now say "It states agent-agnostic positioning." The README does not use the words "agent agnostic" as the old sentence implied, so the new sentence describes it accurately.
  • Block quote rewrapped: the shorter sentence left an uneven wrap, so the three lines of the quote are reflowed. The other words in the quote do not change.

Closes #1934

Testing

This is a docs-only PR with no tests to run.

node bin/docs-lint.mjs --strict:

Total: 0 findings
Mode: strict, all selected lines

bash bin/check-writing-profile.sh docs/harnesses/README.md printed no findings.

Glossary

Term Definition
Agent agnostic Works with more than one coding agent.
Block quote A Markdown passage marked with a leading > on each line.

🤖 Generated with Claude Code

Closes #1934

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@me2resh me2resh left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved at 385ef314deeb1ac5e71fe8520e69fd58cef47163. All three acceptance criteria are met, and there are no blocking findings. Next action: a human approves this PR for merge. One advisory follow-up is listed under Suggestions.

Code Review: PR #1935

Commit: 385ef314deeb1ac5e71fe8520e69fd58cef47163
Scope: Full

Summary

This PR changes one sentence in two places in docs/harnesses/README.md. The sentence "It says the framework is agent agnostic." becomes "It states agent-agnostic positioning." The PR also rewraps the block quote that holds the first copy.

The change is accurate. The root README has no form of the word "agnostic". Its wording supports the new sentence. It speaks of "your agents" (README.md:18) and says other coding tools can use the same rules (README.md:30-31). The new wording also matches the sentence that line 82 of the same page already used.

The trusted tier check returned Full with the reason "prompt reference". The reason is correct. .claude/skills/setup/SKILL.md:898 and .claude/skills/handover/SKILL.md:1699 name this page as the source of truth for harness support. Both skills read the install command, precondition, and tier. This diff touches none of those. It does not touch the support matrix or the #rebrand-trigger heading.

Acceptance Criteria

Issue Criterion Status Evidence
#1934 Both lines use the new sentence. Met docs/harnesses/README.md:16 and :74 both contain "It states agent-agnostic positioning." The old sentence is gone from this file.
#1934 node bin/docs-lint.mjs --strict reports 0 findings. Met I ran it in the ops checkout, which is at the reviewed SHA. The result is Total: 0 findings, Mode: strict, all selected lines, exit 0.
#1934 No other file changes. Met The range e673c604..385ef314 has one commit and one file, docs/harnesses/README.md, with 4 additions and 4 deletions. The forge lists the same single file.

The issue has no comments, so no comment changes a criterion.

Checklist Results

  • Architecture & Design: N/A. The diff changes prose only.
  • Code Quality: N/A. The diff changes no code.
  • Testing: ✅ Pass. The PR states that it has no tests to run. A search of the reviewed tree found no test or tool that pins the old or the new sentence. The file has one tracked copy, so no mirror needs the same change.
  • Security: N/A. The diff has no secrets, input handling, or trust-chain paths. The Security Auditor's checklist was not run here.
  • Performance: N/A. The diff changes prose only.
  • PR Description & Glossary: ✅ Pass. The body has a summary, a Testing section, Closes #1934, and a two-term Glossary. The title and the branch follow .claude/rules/git-conventions.md, and the base is dev.
  • Summary Bullet Narrative: ✅ Pass. Both bullets state what changed and why.
  • Technical Decisions (AgDR): N/A. This is a wording fix to a recorded owner decision, not a new material decision.
  • Adopter Handbooks: ✅ Pass. handbooks/general/commit-message-quality.md was loaded and has no finding. The commit has no body, but the diff is 8 lines, and the handbook flags a missing body only above 50 lines. The architecture and TypeScript handbooks do not apply. handbooks/domain/ has no handbook. The private handbook directory does not exist, so no private layer applies.
  • Fallow Static Analysis (JS/TS): N/A. The diff has no JS or TS files.

Issues Found

None

Suggestions

suggestion: docs/conformance-ci.md:50 still says "It says the framework is agent agnostic." This is the same inexact sentence that #1934 fixes. PR #1933 added it, so this PR did not introduce it. The scope of #1934 excludes that file, and its third criterion forbids a change here. File a separate ticket for this one line. Replace it with "It states agent-agnostic positioning."

Validation

Current checks at the reviewed SHA:

  • CI check-run list, read once: every check is complete, and every run reports head SHA 385ef314deeb1ac5e71fe8520e69fd58cef47163.
  • CI passes: CodeQL, Analyze (actions), Verify Ticket ID, check, markdownlint-cli2, records-lint, report, tier, and hook test suite.
  • CI skips: hook tests, conformance, and nightly-failure. .github/workflows/tests.yml:60 skips hook tests when the tier is docs. Lines 139 and 171 limit the other two to a release tier or a scheduled failure. These skips are expected for this PR.
  • node bin/docs-lint.mjs --strict: 0 findings, exit 0. The output matches the PR body.
  • bash bin/check-writing-profile.sh docs/harnesses/README.md: no findings, exit 0. The output matches the PR body.
  • A word diff of the range confirms the rewrap claim. The sentence is the only word change. In the quote, only the > markers move, on three lines.
  • Word searches: the root README has no match for "agnostic" or "built for Claude". The old sentence survives only at docs/conformance-ci.md:50.

Limits:

  • docs-lint could not run in the scratch export, because it needs a git repository. I ran it in the ops checkout. That checkout has four untracked directories, and the lint lists tracked files only.
  • I did not view the rendered page. The only structural change is a rewrap inside the block quote, and markdownlint passed in CI.

Verdict

APPROVED

The diff does what #1934 asks, and all three criteria have evidence. The new sentence matches the root README and the rest of the page. CI is green at the reviewed SHA. The one finding is advisory and concerns a line outside this PR's scope.


🤖 Reviewed by Rex (Code Reviewer Agent)
📌 Reviewed commit: 385ef314deeb1ac5e71fe8520e69fd58cef47163

@me2resh me2resh added the ready-to-merge Rex approved; the refresh Action keeps this PR up to date label Oct 31, 2026
@atlas-apex

Copy link
Copy Markdown
Collaborator

Closed unmerged: reopened under atlas-apex, because an author cannot approve their own PR.

@atlas-apex atlas-apex closed this Oct 31, 2026
@me2resh
me2resh deleted the feature/GH-1934-harness-readme-wording branch October 31, 2026 09:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

github-issue has-ticket ready-to-merge Rex approved; the refresh Action keeps this PR up to date

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants