Skip to content

docs: correct six sentences from the 1.16.0 README refresh (#247) - #248

Merged
mergify[bot] merged 1 commit into
mainfrom
docs/247-readme-corrections
Oct 22, 2026
Merged

mergify[bot] merged 1 commit into
mainfrom
docs/247-readme-corrections

Conversation

@ericlitman

Copy link
Copy Markdown
Owner

Summary

Fix-forward for #246. An independent read of #246 against main found six sentences that do not match the files they describe. This PR corrects them and changes nothing else.

 README.md
-  :177  lists each adaptation ... in UPSTREAM.md
+  :177  upstream changes it leaves out in UPSTREAM.md; adaptations in CHANGES.md
-  :46   For the full three-model review, install and sign in to ...
+  :46   For the default three-model review, install and authenticate ...
-  :96   setup offers ... when the project has none
+  :96   the verification offer applies when the project has no way to drive the app;
+        a rerun that changes nothing only mentions each offer
-  :21, :154 (2 cells)  signed-in command-line tool(s)
+  :21, :154 (2 cells)  command-line tool(s)
-  :157  pstack itself runs inside Claude Code or Codex
+  :157  Open Pstack itself runs inside Claude Code or Codex
 docs/reference.md
-  :5    Grok and six read-only providers run as lanes through the bundled runner
+  :5    lanes on other providers' models, including Grok and six read-only providers

Evidence

Sentence Source on main
README.md:177 UPSTREAM.md:15: "CHANGES.md and NOTICE.md describe the adaptations and provenance"; README.md:168 calls CHANGES.md the record of every adaptation
README.md:46 model-catalog.md, Role defaults: arena, architect and interrogate default to Claude, Codex and Grok
README.md:96 setup-pstack/SKILL.md steps 10 and 11: each offer applies when the project lacks that capability, and a qualifying rerun mentions it in one line; CHANGES.md 1.16.0
README.md:21, :154 model-catalog.md:102: Grok accepts XAI_API_KEY; CHANGES.md 1.12.0: OpenCode's free model needs no key
README.md:157 README.md:13: Lauren's pstack runs in Cursor
docs/reference.md:5 model-catalog.md, Routes: Codex from a Claude Code parent and Claude from a Codex parent also use the runner
  • Before: on main, each sentence above contradicts or leaves out its source.
    After: on this head, each matches its source. Relative links: 46 checked, 0 broken.

Merge Danger

Door: two-way

Seven sentences of documentation. A revert restores them.

Blast Radius: docs

Only readers of README.md and docs/reference.md see a change.

Acceptance criteria (#247)

  • "Each of the six sentences matches the file it cites." Done. See the Evidence table.
  • "No other text changes." Done: 7 insertions and 7 deletions in two files.
  • "The live gate records no runtime change." Pending: the live-gate status on this head.

Gate results

Run on head d585f45f7a7f3a391a776570e5a5eaca4120e96c, macOS, Bun 1.4.0:

Check Exit Result
bun run test 0 505 pass, 0 fail, 19 files
bun run typecheck 0 no errors
bun run static 0 201 pass, 0 fail, 12 files
claude plugin validate plugins/pstack 0 Validation passed

Not verified

  • No harness runs this text. README.md and docs/** are nonRuntime in the verifier registry, so the live gate records the classification, not a session.
  • docs/reference.md:89's optional-model list is incomplete. It is outside README: correct six sentences from the 1.16.0 refresh #247's scope and recorded on the issue.

Closes #247

🤖 Generated with Claude Code

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

Copy link
Copy Markdown
Owner Author

Live evidence: Open Pstack

  • Candidate SHA: d585f45f7a7f3a391a776570e5a5eaca4120e96c
  • Base SHA: bebfc0a82529979f8096ddf8bb72e8df28d092c3
  • Result: PASSED — no runtime change
  • Self-test: not requested
  • Planned sessions: 0 (limit 12)
  • Publisher revision: bebfc0a82529979f8096ddf8bb72e8df28d092c3
  • Evidence-set SHA-256: ba39baf0f002da0420c051a84e5b4c1b27840c3f9949f7ce6a3f70c08448a8a3
  • Policy: every new head requires a fresh run; this verifier does not change PR state, queue, or merge.

@mergify

mergify Bot commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

Merge Protections

🟢 All 2 merge protections satisfied — ready to merge.

Show 2 satisfied protections

🟢 Queue ready pull requests

Automatically queue non-draft pull requests targeting main after verify and live-gate pass on the head and every review thread is resolved.

  • #review-threads-unresolved = 0
  • -draft
  • check-success=live-gate
  • check-success=verify

🟢 🚦 Auto-queue

When all merge protections are satisfied and these conditions match, this pull request will be queued automatically.

  • -files~=^\.github/
  • base = main

@mergify
mergify Bot merged commit b4c5e3d into main Oct 22, 2026
7 checks passed
@mergify

mergify Bot commented Oct 22, 2026

Copy link
Copy Markdown
Contributor

Merge Queue Status

  • ✅ Entered queue — 2026-10-22 07:30 UTC · Rule: default · triggered by merge protections
  • ✅ Checks skipped · PR is already up-to-date
  • ✅ Merged — 2026-10-22 07:30 UTC · at b4c5e3d63318308b7e11f26b2bc156e7793d834a · merge

This pull request spent 7 seconds in the queue, with no time running CI.

Required conditions to merge

@greptile-apps

greptile-apps Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

RetriggerView in Greptile

[Low impact] This documentation-only PR appears safe to merge.

Summary

This PR corrects documentation about provider tools, setup offers, supported apps, and upstream records.

  • Provider docs explain how other models join the Claude Code and Codex workflows.
  • The install guide names the tools for the default three-model review.
  • Setup explains when each verification skill is offered.
  • Upstream changes and local adaptations point to separate records.

Reviews (1) · Last reviewed commit: "docs: correct six sentences from the 1.1..." · Reviewed by Greptile

@unfret-eal

unfret-eal Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

✅ No blocking findings

Light review ran with 1 elected reviewer.

Walkthrough

This is a docs-only follow-up to #246 that corrects sentences in `README.md` and `docs/reference.md` that misdescribed the files they point to. The README now says adaptations are recorded in CHANGES.md (UPSTREAM.md holds only omitted upstream changes). It calls the Claude/Codex/Grok trio the default review and drops the "signed-in" wording, since Grok accepts an API key and OpenCode's free model needs none. It also spells out when setup offers each verification skill and that a no-op rerun only mentions them, and names Open Pstack rather than pstack as what runs inside Claude Code or Codex. The reference intro now says the runner handles all lanes on other providers' models, not just Grok and the read-only providers. No code or runtime behavior changes; the author reports tests, typecheck and static checks passing on the head.

Area What changes
README accuracy Fixes the upstream/adaptation record pointer, the "default" review wording, the CLI auth wording in two table cells, the setup verification-offer conditions, and the product name in the runtime note.
Reference intro Broadens the runner sentence to cover every cross-provider lane, including Codex and Claude when launched from the other app.
Details
Lane / stage Model Effort Outcome Duration
focal-gpt-5.6-sol-xhigh copy / review openai/gpt-6.1-sol → gpt-6.1-sol · primary xhigh succeeded 4 min 28 s

First review of this pull request.
1 reviewer finished.
Commit d585f45.
Check run.
Run: GET /unfret/run/panel:d585f45f7a7f3a391a776570e5a5eaca4120e96c:JKxwOeI8Pc3:-9gCgA7B9KM.

@unfret review · @unfret status · @unfret help

@unfret-eal unfret-eal Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

✅ No blocking findings
Check

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README: correct six sentences from the 1.16.0 refresh

1 participant