docs(using,guides): refresh the using/guides/entry-point pages for v0.66.2 - #779
Merged
Conversation
added 10 commits
August 8, 2026 07:17
…p stale coverage figures
…t plugin inheritance
… + batch suppression
Deploying paddock with
|
| Latest commit: |
8bf1e29
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://55083537.paddock-7u2.pages.dev |
| Branch Preview URL: | https://docs-using-guides-0-66.paddock-7u2.pages.dev |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs last had a systematic pass at v0.62;
mainis v0.66.2. This is theusing/+guides/+ entry-point group: 12 WRONG, 10 STALE, 6 MISSING items, eachre-verified against source at
b38dff2before editing.Docs-only — no changeset, no version bump.
cd website && npm install && npm run buildexits 0 (51 pages).
The
import→adoptdecision (and why it reads the way it does)I led with "adopt" everywhere, and where a page describes what the CLI prints, I say
so explicitly and cite #770.
The constraint: the web UI is uniformly adopt since #748 — zero user-visible
"import" strings in
packages/web/src. Butpaddock --helpand the CLI's startup textstill say "import", and so do the OpenAPI route summaries. Aligning the docs on "adopt"
alone would make
getting-started.mdcontradict the first thing a brand-new user readsin their own terminal.
So rather than pick one and let the reader hit the mismatch cold, three pages now name
it as a known lag with a link to #770 —
getting-started.md,what-paddock-touches.md,and
working-in-chats.md. When #770 lands, those three parentheticals come out andnothing else needs to change.
npm run import-chatskeeps its name, as #770 says it should.working-in-chats.mdnow explains why it keeps it, so the next pass doesn't "fix" it.
One correctness fix rides along:
what-paddock-touches.mdsaid "Import copies,never moves". That is both the retired vocabulary and a claim #748 corrected as false —
under
transcripts: hostthere is no copy, because.chatsalready is your Claudehome. The page now states the invariant that holds in both modes: your originals are
never moved or deleted.
The
claude-CLI-and-triggers claim (W4–W7)Four pages said the
claudebinary is needed for triggers. It isn't, on the defaultdrive mode. Verified end to end before editing:
ws-triggers.ts:70-74resolves a trigger's drive mode exactly like a chat's (projectoverride, else
cfg.driveMode) and passes it at:189ws-turn.ts:550-553branchessession→chatSession/batch→chat@herdctl/corejob-control.js:414—openChatSessionhard-codesnew SDKRuntime(...),never consults
PATHmodels.ts:168—DEFAULT_DRIVE_MODE = "session"herdctl.ts:1614— the sweeper'smanager.trigger(...)is the one unconditional callCorrected in
getting-started.md,contributing.md,guides/home-lab.md,guides/agent-capabilities.md, plus a fifth instance the audit didn't flag: the scopenote in
contributing/testing.md, which made the same claim about which agent linesgovern which runtime.
Fixed to the verified behaviour, not the source comments — those comments are the
origin of the error and are tracked as #771, cited in the two contributor-facing
pages so this doesn't regress on the next read-through.
Everything else
WRONG —
proxmox-lxc.mdhealth check on port 3000 → 7233 · History origin chip"Imported" → Adopted · dead anchor
#import-your-terminal-claude-history→#adopt-your-terminal-claude-history· the sweeper'sCLAUDE.mdaxis ismanaged(derived
!(repo || path)), not "non-repo-backed" — the old wording wrongly promised acurated
CLAUDE.mdto an unmanagedpath:-only project ·index.mdx's "Project-first"card rewritten off the retired
repoBackedtype onto the two real axes · testing.md'sserver.mjs:119→:127· the E2E layer is 20 specs / 4 Playwright projects / 2servers, not one spec file · the "error states, file pins, git UI not yet driven from
the browser" gap is closed (those specs exist).
MISSING — M1 is the security one:
guides/securing.mdnever stated thedriveMode: batchcredential-in-argv exposure, despite being the page an operator readsbefore handing Paddock a token. Now a danger box + a checklist line, with the two things
that actually bite: a single project pinning
batchreintroduces it instance-wide,and on a multi-user box it means every local account can read the token. Also added:
promote_projectas a second agent-chosengit cloneroute (repois its onlyrequired arg — easy to miss) in both
untrusted-content.mdand the write-scope dangerbox in
connect-claude-code.md;run_triggerin two tool lists; host plugininheritance as a truth table (
mcpServers: hostalone inherits no plugins —enumeration gates on
instructions) plus themcp__plugin_<plugin>_<server>__*allowlist shape; and
environmentPrompt— including that it is silently not appendedon
driveMode: batch, which is exactly whatagent-capabilities.mdtells you to pinfor Docker isolation.
STALE —
--helpenv-override annotations ·import-chatsneeds--project(exits2 without it) · CI's
check:nuland docs-site build steps · the release also publishesto npm via OIDC · per-file test enumeration replaced with directory shape (it named 6
unit / 8 integration; there are 100 / 58, plus 72 web) ·
test:unit/test:integrationscripts ·
sessionhas been the default since v0.36.0 (#316) ·list_triggersaddedto the
hooksMcpEnabledrow.What I left, and why
predates ~150 test files. Rather than mint a number that goes stale again, the page now
says how to measure it and notes
@vitest/coverage-v8is already a devDependency.architecture/herdctl-integration.md:105carries the same dead anchor asscheduling-recurring-work.md:102. Out of scope — the concepts/architecture child owns it.written so images slot in later without rework. One thing fixed regardless:
creating-and-organizing-projects.md:405ended a sentence in a colon with nothing afterit, reading as a dropped image — now a complete sentence.
if-no-files-found: ignorehides it #774 (CI never uploads the Playwright report):contributing/testing.md's lineabout artifacts going to the temp dir is correct and stays. Added a note so a
contributor doesn't hunt for a report that was never uploaded.
Two audit corrections
contributing/testing.md's scope note — same error, contributor-facing. Fixed.working-in-chats.md:46-49described adoption matching as "by checkout name for arepo-backed project, by exact path for a notebook one". The real axis is
project.repo !== null(adoptable.ts:531-552), not managed/notebook — and the pageomitted that since bug(adopt): repo-backed source matching is basename-only, pulling in unrelated dirs (hushpod offers another instance's chats) #659 a same-basename directory must prove it is a clone of that
repo (a git remote must point there) before anything from it is offered. Both corrected.
🤖 Generated with Claude Code