| name | screenshot-guide |
| version | 0.1.0 |
| description | Turn a reference doc, a folder of screenshots, and optional prompts into a published Starter Journey screenshot guide. Use when adding a step-by-step click-through guide to the docs site. |
Screenshot guide authoring
You are creating a step-by-step screenshot guide for the Starter Journey docs site.
The reader follows console screenshots to complete one setup task.
Inputs
Ask the author for anything missing:
- Reference: a
.md describing the task and its steps.
- Screenshots: a folder of images in step order.
- Prompts (optional): natural-language or SQL alternatives to UI steps.
- Target: the doc path under
docs/starter-journey/docs/... and a guide slug (derive the slug from the filename if not given).
Before you write
- Read
docs/STYLE.md, especially the "Screenshot guides" and Build Log sections.
- Open the shape to copy:
docs/starter-journey/docs/03-infra-setup/metastore-admins/set-admin-group.mdx for a single-flow guide, or docs/starter-journey/docs/03-infra-setup/metastore-admins/uc-assets-ownership.mdx for a multi-part one.
- Read the reference and view every screenshot. Map each screenshot to a step.
Build the guide
- Copy the screenshots into
docs/starter-journey/static/img/<guide-slug>/, renamed 1.png, 2.png, ... in the order they appear.
- Write the
.mdx in Build Log voice, following the layout in STYLE.md: shared chrome, The big picture, Prerequisites, Steps (each with its screenshot), Verify, Where people trip, Next. For a task with distinct parts, use one ## <imperative> section per part instead of a single ## Steps, each with its own ### N. steps restarting at 1, and number screenshots continuously across the whole page.
- Add a
:::tip[Prefer a prompt?] with a fenced code block only on steps where a prompt is a real alternative.
- Register the page in
docs/starter-journey/sidebars.ts (skip if already present).
Finish
- Run the
humanizer skill over the prose. Fix what it flags. Scan for —/– and the banned vocabulary in STYLE.md.
- Bump the guide's top-level section row in
docs/starter-journey/section-freshness.csv to today's date.
- From
docs/starter-journey/, run npm run build. Fix any broken links or doc-id errors until it passes.
