[tylerpaxton]

Type of change

Documentation update to two existing pages, plus a new quickstart shortcode and its styles.

What should this PR do?

Opens Get started with Chainguard Checks and Get started with Chainguard Workspaces with a quick start in a bordered block:

1. Sign up with chainctl develop init, and link the GitHub account that owns the repository.
2. Install the Chainguard App when chainctl develop init offers to, or ahead of time.
3. For Chainguard Checks, draft checks from GitHub Actions workflows with chainctl checks migrate --dry. For Chainguard Workspaces, open a session with chainctl develop.

The block ends with a line marked with a check icon that sends the reader to the step of the full guide where they pick up: Step 4 for Checks, Step 3 for Workspaces. The intro now names both paths, and the existing steps sit under a new Step-by-step guide heading that says how it differs from the quick start. Their text and anchors don't change, so the existing inbound links to #step-2-add-a-configuration-file-to-your-repository and #step-2-open-a-session still work.

The new quickstart shortcode (layouts/shortcodes/quickstart.html, with a .md twin for the Markdown output) wraps the Markdown in a div. Call it with {{% %}} so the heading inside stays in the table of contents. assets/scss/components/_quick-start.scss draws the border, the numbered circles and the line between them, the heading-size step titles, and the closing line ({.quick-start-done}). Its colors derive from --primary-1, so it works in light and dark mode.

Why are we making this change?

The Get started free buttons on chainguard.dev/checks and chainguard.dev/workspaces link to these two pages, and an email campaign that sends readers there goes out on Thursday, October 22. A first-time reader should see the whole setup at a glance, and know where the quick start ends and the full guide begins.

What are the acceptance criteria?

• Each page opens with a bordered quick start of three numbered steps that ends by linking to the right step of the full guide.
• The table of contents lists Quick start and Step-by-step guide, and existing anchors still resolve.
• The block renders in light and dark mode, on desktop and mobile.
• Every command and claim matches chainctl 0.2.388.

How should this PR be tested?

Rendering, on the preview deployment: checked at 1280 px and 390 px wide in light and dark mode. Checked that the built CSS includes the .quick-start rules, that the TOC links to #quick-start, and that the step-* anchors are unchanged.

Content, against chainctl 0.2.388 and its source in chainguard-dev/mono:

• chainctl develop init --help and develop_init.go: the command asks which GitHub account to link (Enter for your own GitHub user, or an organization name) and offers to open the Chainguard App's installation page when the app isn't installed on that account.
• chainctl checks migrate --dry -o json | jq -r .document writes the draft document. Run in a scratch repository with no workflows, it writes checks: {} with no warning, which is why the quick start asks for a repository that runs GitHub Actions workflows and the step-by-step guide covers repositories without them.
• chainctl checks validate fails on a repository with both .chainguard/ci.yaml and .chainguard/ci/migrated.yaml, which is why the guide's intro sends quick-start readers to Step 4.
• checks_migrate.go doesn't write a file itself, so the step saves the draft with jq, as Migrate from GitHub Actions does.

Not run end to end: a full chainctl develop init sign-up with a new organization, and chainctl checks migrate against a real repository's workflows.

🤖 Generated with Claude Code

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated
chainguard-docs-preview	Ready	Preview	Oct 21, 2026 9:51pm UTC

1 Skipped Deployment

Project	Deployment	Actions	Updated
chainguard-docs	Ignored		Oct 21, 2026 9:51pm UTC