Skip to content

List the new guides in the README and fix the install doc's hook count - #4403

Merged
capy-ai[bot] merged 4 commits into
mainfrom
docs-index-and-install-hooks
Nov 16, 2026
Merged

capy-ai[bot] merged 4 commits into
mainfrom
docs-index-and-install-hooks

Conversation

@garrytan

@garrytan garrytan commented Nov 16, 2026 •

Copy link
Copy Markdown
Owner

The README's docs table now links the two new guides, and the install and uninstall docs now list every hook that setup can register.

Why: the guides were missing from the index, and docs/install.md said setup registers "up to three hook families" before naming a fourth, and never mentioned the opt-in hooks.
Nothing to do as a reader.

Agent notes

What changed. README.md: two rows under the how-to entries, for docs/howto-land-a-fix-in-someone-elses-repo.md and docs/howto-run-human-playtests.md (added in #4380). docs/install.md: the hooks intro drops the wrong count ("up to three hook families"; setup also registers the default-on timeline Stop hook), and one new paragraph names the two opt-in hooks, skill routing on UserPromptSubmit and skill contracts on Stop, both off by default, linking docs/skill-routing-and-contracts.md, then points to the opt-in /plan-ceo-review and /autoplan skill gates in docs/skill-gates.md. docs/uninstall.md: the manual hook-removal list now names the skill-contracts, skill-routing and skill-gate hooks. Plus a changelog fragment.

Not docs-only. README.md and docs/install.md are named by workflows and other files, so bin/gstack-docs-only prints DOCS_ONLY: no and full CI runs.

Review. Light depth, docs class: one pass by the lead reviewer, no dispatched readers (the review plan skipped specialists, red team and second-model review). One informational finding, docs/install.md:29 (the uninstall doc's manual list did not name the opt-in hooks), fixed in f1e7f78. The documentation audit then found the new opt-in paragraph still missed the two skill-gate hooks (./setup --ceo-review-gate, --autoplan-gate, setup lines 63-70) and fixed both docs (5f8b35f). Gate edits: none detected (0 tagged).

Documentation.

Status: updated. Two factual hook-list corrections; no blockers.

Scope: committed changes from 984a268 to c4c970e (3 commits: README.md, changelog.d/docs-index-and-install-hooks.md, docs/install.md, docs/uninstall.md); no staged, unstaged or untracked content selected. Claims checked against setup, bin/gstack-settings-hook, docs/skill-routing-and-contracts.md and docs/skill-gates.md.

Documentation health:

  • README.md: Current (both new guide links resolve)
  • docs/install.md: Updated (the opt-in hook paragraph now also points to the /plan-ceo-review and /autoplan skill gates)
  • docs/uninstall.md: Updated (manual hook removal now names the skill-gate hooks)
  • changelog.d/docs-index-and-install-hooks.md: Current (accurate; does not mention the skill gates)

Coverage debt: none new. This PR only adds documentation, and every hook it names has reference docs (skill-routing-and-contracts.md, skill-gates.md).

Diagram drift: none; the diff has no diagrams or code entities.

Checks run locally. gstack-prose-lint --gate on the fragment: ok. Pre-push guards: pass. Sealed guard: clear. Tests run in CI at the pushed head.

Approvals

Plan: exempt: audited-list
Plan check: exempt audited-list

Refs GST-2757.

Agent notes
{
  "schema_version": 1,
  "pr": 4403,
  "head": "5f8b35f4acef8c70fd751bdd961f9353f660111b",
  "version": "1.99.5.0",
  "base": "main",
  "gate": {
    "test": {
      "pass": 1669,
      "fail": 0,
      "skip": 0
    }
  },
  "ci_carried": [
    {
      "lane": "test",
      "run": 43797150717,
      "attempt": 1,
      "tree": "fcec424b58fe47d4e5a81413c13958ac3b4c088a"
    }
  ],
  "session_kind": "unattended",
  "head_tree": "fcec424b58fe47d4e5a81413c13958ac3b4c088a",
  "product_patch_id": "bb89a2fd3f053d456fab18b2a0e32a5b18e5a85d",
  "gstack_version": "1.99.5.0",
  "review_depth": {
    "depth": "light",
    "class": "docs",
    "runtime_lines": 0,
    "rules": "66e5174161eecc2c",
    "base": "9e6a96c677431465de3b2d8d3c38d14f64811cd0",
    "registry": "9e6a96c677431465de3b2d8d3c38d14f64811cd0",
    "gate_scan": {
      "tagged": 0,
      "head": "5f8b35f4acef8c70fd751bdd961f9353f660111b"
    },
    "reasons": [
      "runtime=0"
    ],
    "risk": [],
    "mode": "panel"
  },
  "pregate": "requires-remote cleared @fcec424b58fe (8 checks, current for 5f8b35f4acef)",
  "requires_remote": [
    "free-tests.yml/macos-named-regressions: https://github.com/garrytan/gstack/actions/runs/43797150717/attempts/1",
    "pregate.json/remote_gate: remote-gate tree=fcec424b58fe tests=37307 skipped=81 runs=43797150717/1 profiles=ci-reuse/free-tests heads=5f8b35f4acef verified=2026-11-16T03:23:13.078Z"
  ],
  "issues": {
    "fixes": [],
    "refs": [],
    "flakes": []
  },
  "docs": {
    "status": "updated",
    "scope": "README.md and docs/ (committed changes 984a2683..c4c970e7)"
  },
  "review_loop": {
    "passes": 1,
    "blocking_found": 0,
    "deferred": 0,
    "noted": 0,
    "fixed": 1,
    "scope": "frozen",
    "rounds": 1
  },
  "gate_dispositions": []
}

Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com>
@trunk-io

trunk-io Bot commented Nov 16, 2026 •

Copy link
Copy Markdown

😎 This pull request was merged.

garrytan and others added 3 commits November 16, 2026 03:03
Review-Finding: docs/install.md:29:docs-accuracy reader=core
Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com>
Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com>
Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com>
@capy-ai
capy-ai Bot merged commit 8c3c39b into main Nov 16, 2026
78 checks passed
@garrytan garrytan mentioned this pull request Nov 17, 2026
capy-ai Bot added a commit that referenced this pull request Nov 17, 2026
- /autoplan's approval page no longer hides a reviewer's product objection behind "keep your direction". (#4431)
- Every skill that loads the shared preamble, on every host, now says to ask a question once and to check a file before handing it over. (#4383)
- The Captain manuals now name the `Failed or skipped:` and `Also changed:` lines that READY and lane reports carry. (#4432)
- gstack's shell locks hold again on Ubuntu 26.04, where `mkdir` reports success when another process won the race (GST-2247). (#4262)
- `test/gstack-lock-race.test.ts` runs the old pattern and the helper against a PATH shim that behaves like uutils 0.8.0 `mkdir`, so it runs on any runner image: the old pattern lets two of four racers win, the helper admits exactly one in each of 60 races and never overlaps across take, hold and release loops, and parallel `gstack-config` writers keep every key. (#4262)
- Windows Setup E2E now runs when `bin/gstack-lock.sh` changes. (#4433)
- Claude Code's skill list now says when to use each gstack skill, so Opus loads /review and /plan-eng-review when a request fits. (#4387)
- A pull request's merge head can no longer keep its `/ship` receipt without a full review. (#4365)
- `/ship` now counts review rounds per pull request, and the head that merges always gets a full review. (#4360)
- /ship's documentation audit no longer accepts a passing result when an earlier line from the same audit said "blocked". (#4434)
- /ship's documentation audit no longer spends an attempt when the audit child writes text after its result. (#4285)
- The README lists the two new guides, and the install doc counts its hooks right. (#4403)
- docs/releases.md now says the stable release cut treats a failed commit status as red and a pending one as still going, as it has since #4257. (#4436)
- /ship's `finish --docs-requested` now accepts a docs fix when the audit named the file with a line number. (#4437)
- Document the `.gstack/approval-classes.json` schema, `gstack-approval-classes` CLI commands, and owner approval citation format in `docs/ship-policy.md#approval-classes`. (#4355)
- `/eval-plan` now runs four result checks instead of leaving them to judgment. (#4384)
- The /review coverage-audit eval no longer fails a run that really read the source file when zsh stops a command line at an `echo ====` separator. (#4364)
- Sixteen in-repo documentation links reach their section again. (#4394)
- gstack agents now open every status report with what failed, what they didn't verify and what else they changed. (#4273)
- Two new short guides. (#4380)
- A skill you wrote whose contract still lists `check_after_last_edit` keeps the rest of its contract. (#4439)
- The ship policy guide now explains how to merge any pull request with `gstack-ship-queue land`, even in a repository with one maintainer. (#4377)
- /ship's test step runs a large unit suite on Linux. (#4426)
- Every skill that loads the shared preamble, on every host, now says never to print a whole environment, git config or process table. (#4382)
- Pull requests from /ship now open with at most three plain lines, and every merge lands as one commit titled with the PR title. (#4438)
- `gstack-pr-wait`, `gstack-ci-gate` and the release cut no longer call a commit green while a check on it failed. (#4257)
- `gstack-runaway` now says what a thread's cold and empty wakes cost, not just how many there were (GST-2770). (#4385)
- The optional Stop hook no longer checks for a test run after the last edit, and /verify asks for it in plain words instead. (#4428)
- /ship's test step says when it ran out of time, and you can set its budget. (#4429)
- The remote test command no longer puts every file on one command line. (#4429)
- The stable release no longer waits on the nightly Windows tests (GST-2815). (#4400)
- Ubicloud fan-outs can no longer overshoot the vCPU limit, and owners no longer delete each other's VMs. (#4430)
- hono is pinned to 4.13.16, which fixes five advisories the weekly OSV scan found in 4.13.13 (gstack#4406). (#4408)
- `package.json` overrides (#4408)
- `test/dependency-security.test.ts`: the lockfile floor check now covers `hono >= 4.13.16`. (#4408)
- The nightly Windows test run finishes again. (#4409)
- A short write-up checklist in ETHOS.md. (#4381)

Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com>
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.

1 participant