DSDS Steps Document Block

2 definitions in this file:

steps
stepEntry

Identifies this block as a procedure.

The steps, in display order. Each item is a single step with a title and optional instruction, examples, and expected result. Ordering is significant, so tools MUST preserve it for ordered procedures.
Min items: 1

An optional heading for the whole procedure (e.g., 'Installation', 'Build your first component', 'Submitting a contribution').

Whether the steps must be followed in order. Defaults to true (a sequential procedure). Set false for an unordered checklist where steps are independent. Tools SHOULD render ordered procedures as numbered lists and unordered ones as a checklist or bulleted list.
Default: true

References:

stepEntry

{ "kind": "steps", "title": "Installation", "ordered": true, "items": [ { "title": "Install the package", "instruction": "Add the UI package to your project.", "examples": [ { "title": "npm", "presentation": { "kind": "code", "language": "bash", "code": "npm install @acme/ui" } } ], "expectedResult": "`@acme/ui` appears in your `package.json` dependencies." }, { "title": "Wrap your app in the provider", "instruction": "Mount the `ThemeProvider` at the root of your application so every component inherits the theme.", "examples": [ { "presentation": { "kind": "code", "language": "tsx", "code": "import { ThemeProvider } from '@acme/ui'\n\nexport default function App({ children }) {\n return <ThemeProvider>{children}</ThemeProvider>\n}" } } ], "expectedResult": "Components render with Acme's default light theme." }, { "title": "Enable dark mode", "instruction": "Pass the `dark` scheme to the provider to opt into the dark theme.", "optional": true } ] }

A short label for the step (e.g., 'Install the package', 'Wrap your app in the provider', 'Run the validator'). Concise enough to serve as a numbered list item or heading.

What the reader should do in this step. Supports markdown by default. MUST be concrete and actionable: describe the action, not the goal.

Illustrative material for the step: a code snippet, a terminal command, a screenshot, or a live URL. Most procedural steps carry a single code example.

What the reader should see once the step succeeds (e.g., 'The dev server starts on port 3000', 'A themed button renders'). Lets readers confirm progress and spot problems on their own. Most useful in tutorials and getting-started guides.

Whether the step can be skipped without breaking the procedure. Defaults to false. Tools MAY render optional steps distinctly (e.g., an 'optional' label).
Default: false

References: richText, example

{ "title": "Install the package", "instruction": "Add the UI package to your project with your package manager.", "examples": [ { "title": "npm", "presentation": { "kind": "code", "language": "bash", "code": "npm install @acme/ui" } } ], "expectedResult": "`@acme/ui` appears in your `package.json` dependencies." }