Skip to content

docs: Running as a service and Updating, in the shared CLI-contract wording - #997

Merged
edspencer merged 1 commit into
mainfrom
g-docs-2
Nov 5, 2026
Merged

edspencer merged 1 commit into
mainfrom
g-docs-2

Conversation

@edspencer

Copy link
Copy Markdown
Owner

Docs: "Running as a service" and "Updating" in the shared CLI-contract wording (G2)

Both pages now follow the wording all six tools share (cli-contract SPEC 0.2), with the slugs and sidebar labels unchanged (guides/running-as-a-service — "Keeping Paddock running on your laptop"; guides/updating — "Updating Paddock"); only the page titles changed, to "Running as a service" and "Updating".

Running as a service — reorganised into: intro (LaunchAgent / systemd user service, Windows not yet) · Installing (options table, waits until it answers, re-running is safe and keeps the unit's settings, --dry-run, the npx / checkout + --from-checkout / port refusals, linger and "never runs sudo") · Where things are (the unit runs this Node and cli.js by real path; a removed Node → status/doctor warn, reinstall fixes) · The commands (stop doesn't disable; uninstall keeps data and logs; logs 50 / -f / -n; start runs reset-failed; --json on the actions) · Busy (new): stop/restart refuse with 75, --force → Overriding:, uninstall doesn't ask, paddock busy 0/75/3 · Logs (one file, rotated by copy-and-truncate at 8 MB × 3) · Exit codes (new) · the existing at-login/npx/access/known-unverified/Windows/server sections kept · link to Updating.

Updating — the sequence sentence · options table · busy (75 before anything stops) · the 30 s / 20 lines / exit 6 / exit 7 wording · without a service (a foreground serve that answers → asks you to stop it, exit 3) · the exit-5 table including the not-writable sudo row and PADDOCK_UPDATE_HINT · Docker and Watchtower (short, linking Deploying's full Compose block) · no automatic checks · run it from a terminal · exit codes now include 1 and 3 · doctor · step by step · by hand.

Docs-only, so no changeset (CONTRIBUTING). Built locally (cd website && npm ci && npm run build), every new in-page anchor checked in the output (#checking-an-install-paddock-doctor, #linux-linger, #exit-codes, Deploying's #keeping-it-current), and both pages looked at in a browser (light theme, full page): headings, tables, the caution asides and code blocks all render.

🤖 Generated with Claude Code

…ontract wording

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Nov 5, 2026 •

Copy link
Copy Markdown

Deploying paddock with  Cloudflare Pages  Cloudflare Pages

Latest commit: cd96296
Status: ✅  Deploy successful!
Preview URL: https://8d05dc6d.paddock-7u2.pages.dev
Branch Preview URL: https://g-docs-2.paddock-7u2.pages.dev

View logs

@edspencer
edspencer merged commit 17af7ac into main Nov 5, 2026
10 checks passed
@edspencer
edspencer deleted the g-docs-2 branch November 5, 2026 09:05
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