Skip to content

docs: a CLI reference page, and What's New for 0.80–0.83 - #999

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

edspencer merged 1 commit into
mainfrom
g3-docs

Conversation

@edspencer

@edspencer edspencer commented Nov 5, 2026 •

Copy link
Copy Markdown
Owner

Docs only: no changeset, per CONTRIBUTING (docs-only changes don't need one).

What changes

  • New: CLI reference (website/src/content/docs/reference/cli.md), first in the Reference sidebar group. Every command and flag: serve (alias start), service install|uninstall|start|stop|restart|status|logs, busy, update, doctor, config show|eject, -v/-h. Also the conventions every command follows (flags scoped to their commands, --json on stdout with prose on stderr, NO_COLOR/FORCE_COLOR), the exit codes (SPEC §2, as Paddock uses them, including update's 3 and busy's 1), the environment variables the CLI reads (linking to Environment variables for the server's), and the files it writes. It links to Running as a service, Updating and Config profiles rather than repeating them. upgrade is left out, as --help does.
  • What's New: 0.80, 0.81, 0.82 (with 0.82.1 folded in, the way 0.74.1 was) and 0.83, in the page's existing format. The frontmatter description is extended. These are CLI releases, so there are terminal excerpts and no screenshots. Each claim was checked against packages/server/CHANGELOG.md and the built CLI's --help.
  • Getting Started: -q, --quiet added to the flags block (it's in --help since 0.83), plus a link to the reference.

How it was checked

  • The facts come from args.ts and the built CLI (env -u NODE_ENV npm run build), with a throwaway HOME and HOST/PORT unset: --help for every command and action, plus the exit codes for a typo (2), serve --json (2), service status/logs with no unit (4), busy with nothing running (3), --force on uninstall (2), --offline on update (2) and doctor --offline --json (0).
  • website: npm run build exits 0 with 57 pages, and shows only the warnings that were already there (caddyfile). The runbook's orphan/dangling sidebar check reports none.
  • The site has no link checker, so a script checked every internal link and #anchor in the main content of the new and changed pages, plus Updating and Running as a service: 141 links and none broken. A deliberately broken anchor was caught as the positive control.
  • Served dist/ statically and looked at the CLI reference (light and dark) and the new What's New entries in a browser. Headings, tables (none overflow), code blocks and the right-hand TOC all render, and the anchors #083--… through #080--… resolve.
  • No leaks: no hostnames, IPs or box paths in the diff.

Not changed: the in-app What's New card list (packages/web/src/lib/onboarding/whats-new.ts, capped at 12 by its test). It is code rather than docs, and it already stopped at 0.78. Bringing it up to date means bumping entries into the archive, which is a separate change.

🤖 Generated with Claude Code

- reference/cli.md: every paddock command and flag (serve, service, busy,
  update, doctor, config, -v/-h), the exit codes as Paddock uses them, the
  environment variables the CLI reads, and the files it writes. Added to the
  Reference sidebar.
- whats-new.mdx: entries for 0.80 (CLI-contract alignment), 0.81 (busy),
  0.82 and 0.82.1 (update) and 0.83 (doctor and the install checks).
- getting-started.md: --quiet in the flags list, and a link to the reference.

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

Copy link
Copy Markdown

Deploying paddock with  Cloudflare Pages  Cloudflare Pages

Latest commit: 096b725
Status: ✅  Deploy successful!
Preview URL: https://05d2caa6.paddock-7u2.pages.dev
Branch Preview URL: https://g3-docs.paddock-7u2.pages.dev

View logs

@edspencer
edspencer merged commit f97ed74 into main Nov 5, 2026
10 checks passed
@edspencer
edspencer deleted the g3-docs branch November 5, 2026 10:06
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