Skip to content

docs: refresh the README and reference for 1.16.0 (#245) - #246

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

mergify[bot] merged 1 commit into
mainfrom
docs/245-readme-refresh

Conversation

@ericlitman

Copy link
Copy Markdown
Owner

Summary

Refreshes the README and the technical reference for 1.16.0. Lauren's pstack now installs in Claude Code, and the runner reaches nine providers, so the README's account of what Open Pstack adds was out of date.

 README.md
-  opening: "Claude Code or Codex → use this repository"
+  opening: Cursor → Lauren's pstack; Codex → Open Pstack; Claude Code → choose
+           pstack@cursor-plugins (Claude models only) or Open Pstack, install one
   What Open Pstack adds
-    "Beyond translating pstack for Claude Code and Codex"
+    "Compared with Lauren's pstack"
-    other providers: Claude, Codex, Grok; "Grok gets only an allowlisted environment"
+    other providers: all nine, three that write and six read-only;
+                     every provider except Claude and Codex gets an allowlisted environment
+    model sheet: a rerun that changes nothing keeps the sheet without asking
+    panels: Lauren's pstack defaults to Opus 5.5 and Grok
   Get started
-    "asks before saving" + two migration notes (1.2.1, 1.5.0) + optional-model list
+    when setup asks, when it saves quietly, the two verification offers
   Claude Code and Codex table: the read-only providers in "Other models"
   Staying close: the upstream Claude Code install paragraph moves to the opening
 docs/reference.md
-  transcript folder: `/` → `-`
+  transcript folder: each `/` and each `.` → `-`   (the #235 fix in 1.16.0)
-  routes and dispatch: "Claude and Grok" / "Codex and Grok"
+  routes and dispatch: every non-native provider uses the runner
-  "the upstream three-model panel"
+  "Open Pstack's default three-model panel"; Lauren's pstack defaults to two

Evidence

Every changed claim, checked against a file on this branch:

Claim Source
Nine providers; Claude, Codex and Grok write; six are read-only plugins/pstack/skills/poteto-mode/references/model-catalog.md, Routes table
Every provider except Claude and Codex gets an allowlisted environment same table, "Child environment" column
arena, architect, interrogate default to Opus, Sol and Grok model-catalog.md, Role defaults
Lauren's default panel is Opus 5.5 and Grok cursor/main:pstack/README.md line 41, "the default panel is opus 5.5 / grok"
pstack@cursor-plugins has Claude models only and runs the Grok and GPT roles on Claude UPSTREAM.md:36
Lauren's pstack has no Codex build cursor/main:harness/pstack/ holds only claude-code/ and a README that does not mention Codex
Quiet reruns, failed probe stops, the two verification offers plugins/pstack/skills/setup-pstack/SKILL.md:42, steps 10 and 11; CHANGES.md 1.16.0
Transcript folder encoding plugins/pstack/skills/recall/SKILL.md:14
ultra is offered only for Sol (kept) model-catalog.md:15: Luna's efforts stop at max
  • Before: on main, 38 relative links in README.md and docs/reference.md, 0 broken.
    After: on this head, 45 relative links, 0 broken. Each #routes and #role-defaults anchor matches a heading in model-catalog.md.

Merge Danger

Door: two-way

Documentation only. A revert restores the previous text.

Blast Radius: docs

Only readers of README.md and docs/reference.md see a change. No plugin file, skill, script or manifest changes.

Acceptance criteria (#245, current scope)

  • "What Open Pstack adds lists only what Lauren's pstack, in Cursor or in its Claude Code install, does not have. Each item matches main and links to the file that shows it." Done. The verification offers came from upstream (UPSTREAM.md:41), so they are in "Get started", not in this section. The sources are in the Evidence table.
  • "From the opening section, a Claude Code user can tell when to install Open Pstack and when to install Cursor's pstack@cursor-plugins, and that only one of the two should be installed." Done, in the paragraph after the quotation.
  • "The README names all nine provider integrations in one place, says which six run read-only lanes, and links other routing text to that place." Done. The "Models from other providers" bullet names all nine. "Models and token use" and the "Claude Code and Codex" table link the routes table.
  • "The setup description in 'Get started' matches 1.16.0." Done, against setup-pstack/SKILL.md:42 and CHANGES.md 1.16.0.
  • "The two docs/reference.md statements are corrected." Done: the transcript encoding and the cross-vendor paragraph. The design pass found three more stale routing sentences (lines 5, 86, 87 and 89) and the "upstream three-model panel" cell (line 206). This PR corrects those too.
  • "The text stays plain, as the rest of the README is. No promotional wording." Done.
  • "The live gate classifies the change as no runtime change and records that." Pending: the live-gate status on this head.

Gate results

Run on head f04d96f8b04bac2447654ab06ace390665118392, 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 .claude/skills/verify-open-pstack/features/registry.json, so the live gate records the classification, not a session.
  • The rendered page on GitHub is not checked here beyond link resolution.

Closes #245

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@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

@ericlitman

Copy link
Copy Markdown
Owner Author

Live evidence: Open Pstack

  • Candidate SHA: f04d96f8b04bac2447654ab06ace390665118392
  • Base SHA: 06dab3dc546ae7bd6df492c241472c8cf818a23b
  • Result: PASSED — no runtime change
  • Self-test: not requested
  • Planned sessions: 0 (limit 12)
  • Publisher revision: 06dab3dc546ae7bd6df492c241472c8cf818a23b
  • 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 merged commit bebfc0a 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:01 UTC · Rule: default · triggered by merge protections
  • ✅ Checks skipped · PR is already up-to-date
  • ✅ Merged — 2026-10-22 07:01 UTC · at bebfc0a82529979f8096ddf8bb72e8df28d092c3 · merge

This pull request spent 6 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

Refreshes README.md and docs/reference.md for Open Pstack 1.16.0.

  • Claude Code users can choose an install and see how models are routed.
  • The setup guide explains when model choices need approval.
  • The reference explains transcript folder names and upstream changes.

Reviews (1) · Last reviewed commit: "docs: refresh the README and reference f..." · 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 documentation-only refresh of `README.md` and `docs/reference.md` for Open Pstack 1.16.0, so the text matches what the code now does. The opening now says which install to use. In Cursor, use Lauren's pstack. In Codex, use Open Pstack. In Claude Code, choose between Cursor's `pstack@cursor-plugins` (Claude models only) and Open Pstack, and install only one. Both docs now describe the runner as reaching nine providers, three that read or write and six read-only, and link to the model catalog's routes table instead of naming only Claude, Codex and Grok. The "Get started" setup text is rewritten for 1.16.0. It says when setup asks before saving, that a rerun with no changes saves quietly, that a failed probe stops setup, and that setup offers to generate verification skills. In the reference, the transcript folder rule now says both `/` and `.` become `-`, and the three-model panel is described as Open Pstack's default rather than upstream's. No plugin code changes; the author reports tests, typecheck and link checks passing, and the live-gate classification is still pending.

Area What changes
README positioning The opening and "What Open Pstack adds" now compare against Lauren's pstack, which has a Claude Code install and no Codex build. The old closing note about `pstack@cursor-plugins` moves into the opening.
Provider routing docs The README and reference name all nine runner providers and say six run read-only lanes. They say every provider except Claude and Codex gets an allowlisted environment, and point to the catalog routes table.
Setup and reference details The setup behavior text now matches 1.16.0, and the old migration notes are removed. The reference fixes the transcript path encoding, the routing sentences and the panel-default wording.
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 14 min 19 s

First review of this pull request.
1 reviewer finished.
Commit f04d96f.
Check run.
Run: GET /unfret/run/panel:f04d96f8b04bac2447654ab06ace390665118392:rot9nsWseG-:VGdU9hCGvJU.

@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: refresh "What Open Pstack adds" and other stale text for 1.16.0

1 participant