mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
3dc3852b7a
* Improve SEO descriptions across 47 pages Curated descriptions from two bot-generated PRs (#3908, #3949), selecting the best approach for each page: - Added missing title and description frontmatter to 10 API reference pages - Benefit-focused descriptions for integration pages (not implementation-heavy) - Accurate REST-aligned titles for API endpoints (Export, List, Trigger, etc.) - Expanded short descriptions to 50–160 character range throughout Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * copyedit * Update custom-domain.mdx * Fix analytics API page titles to match spec summaries "Export" was inaccurate — spec uses "Get" for both endpoints. Also updated descriptions to use "Retrieve" for consistency. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
66 lines
1.9 KiB
Plaintext
66 lines
1.9 KiB
Plaintext
---
|
|
title: "Steps"
|
|
description: "Create numbered step-by-step procedures with visual indicators to guide users through sequential tasks and tutorials."
|
|
keywords: ["sequence", "numbered steps", "procedures", "tutorial steps"]
|
|
---
|
|
|
|
import IconsOptional from "/snippets/icons-optional.mdx";
|
|
|
|
Use steps to display a series of sequential actions or events. You can add as many steps as needed.
|
|
|
|
<Steps>
|
|
<Step title="First Step">
|
|
These are instructions or content that only pertain to the first step.
|
|
</Step>
|
|
<Step title="Second Step">
|
|
These are instructions or content that only pertain to the second step.
|
|
</Step>
|
|
<Step title="Third Step">
|
|
These are instructions or content that only pertain to the third step.
|
|
</Step>
|
|
</Steps>
|
|
|
|
```mdx Steps example
|
|
<Steps>
|
|
<Step title="First Step">
|
|
These are instructions or content that only pertain to the first step.
|
|
</Step>
|
|
<Step title="Second Step">
|
|
These are instructions or content that only pertain to the second step.
|
|
</Step>
|
|
<Step title="Third Step">
|
|
These are instructions or content that only pertain to the third step.
|
|
</Step>
|
|
</Steps>
|
|
```
|
|
|
|
## Steps properties
|
|
|
|
<ResponseField name="children" type="ReactElement<StepProps>[]" required>
|
|
A list of `Step` components.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="titleSize" type="string" default="p">
|
|
The size of the step titles. One of `p`, `h2`, and `h3`.
|
|
</ResponseField>
|
|
|
|
## Individual step properties
|
|
|
|
<ResponseField name="children" type="string | ReactNode" required>
|
|
The content of a step either as plain text or components.
|
|
</ResponseField>
|
|
|
|
<IconsOptional />
|
|
|
|
<ResponseField name="title" type="string">
|
|
The title is the primary text for the step and shows up next to the indicator.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="stepNumber" type="number">
|
|
The number of the step.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="titleSize" type="string" default="p">
|
|
The size of the step titles. One of `p`, `h2`, and `h3`.
|
|
</ResponseField>
|