Skip to content

Update stepper.md #1603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 23, 2025
Merged

Update stepper.md #1603

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2122b41
Update stepper.md
theletterf Jul 22, 2025
235f027
Update stepper.md
theletterf Jul 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/syntax/stepper.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Stepper

Steppers provide a visual representation of sequential steps, commonly used in tutorials or guides
to break down processes into manageable stages.
to break down processes into manageable stages. For example, you can usee steppers instead of numbered
section headings when documenting a supertask or a complex procedure. An example is the [Observability Get Started](https://www.elastic.co/docs/solutions/observability/get-started).
Copy link
Contributor

@karenzone karenzone Jul 22, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the intention to replace all numbered steps (ordered lists) with steppers? Or do they each have their place based on certain characteristics?

Copy link
Contributor Author

@theletterf theletterf Jul 22, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question. No, no intention to replace ordered lists. I think both have their place, but this would be better described, I think, in a style guide; in the end this documentation is concerned with how the component works, not with how it should be used in Elastic documentation (Docs Builder is an open source docs tool that anyone could use). Here we can suggest, but I don't think we can be prescriptive.

+CC @bmorelli25, as we were talking of style guide consolidation earlier today.


By default every step title is a link with a generated anchor.
But you can override the default anchor by adding the `:anchor:` option to the step.
By default every step title is a link with a generated anchor. You can override the default anchor by adding the `:anchor:` option to the step.

## Basic stepper

Expand Down
Loading