Skip to main content

screenshot-guide

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.

Datos de origen

Repositorio
databricks-solutions/starter-journey
Última actividad en el origen
7 de septiembre de 2026 a las 18:03
Idioma detectado de SKILL.md
inglés
Estrellas
5
Forks
3

Opciones de instalación

De forma predeterminada está seleccionado el prompt que primero revisa el origen. Puedes cambiar a un comando directo o descargar una copia local.

Revisa los archivos de origen

Lee SKILL.md y los archivos complementarios que muestra SkillsMP antes de decidir si quieres instalarlo.

Mostrando SKILL.md

SKILL.md
Instrucciones de origen · Vista previa de solo lectura
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 1. Read `docs/STYLE.md`, especially the "Screenshot guides" and Build Log sections. 2. 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/05-data-governance-strategy/uc-assets-ownership.mdx` for a multi-part one. 3. Read the reference and view every screenshot. Map each screenshot to a step. ## Build the guide 1. Copy the screenshots into `docs/starter-journey/static/img/<guide-slug>/`, renamed `1.png`, `2.png`, ... in the order they appear. 2. Import `StepGuide`, `Step`, and `StepImage` from `@site/src/components/StepGuide`. 3. Write the `.mdx` in Build Log voice, following the layout in STYLE.md: shared chrome, The big picture, Prerequisites, a `StepGuide` containing one `Step` per action, Verify, Where people trip, and Next. 4. Use `StepImage` for screenshots and provide meaningful `alt` text. Keep steps without screenshots as text-only `Step` elements. 5. For a task with distinct parts, use one `## <imperative>` section and one `StepGuide` per part. Give each guide a unique `idPrefix`. 6. Import and use `PromptBlock` from `@site/src/components/PromptBlock` only where a prompt is a real step or alternative. 7. Register the page in `docs/starter-journey/sidebars.ts` (skip if already present). ## Finish 1. Run the `humanizer` skill over the prose. Fix what it flags. Scan for `—`/`–` and the banned vocabulary in STYLE.md. 2. Bump the guide's top-level section row in `docs/starter-journey/section-freshness.csv` to today's date. 3. From `docs/starter-journey/`, run `npm run build`. Fix any broken links or doc-id errors until it passes.
Ver en GitHub