Skip to content

Conversation

@theletterf
Copy link
Contributor

Elaborates a bit on the example

@theletterf theletterf requested a review from a team as a code owner July 22, 2025 17:05
@theletterf theletterf self-assigned this Jul 22, 2025
@theletterf theletterf added the documentation Improvements or additions to documentation label Jul 22, 2025
@github-actions
Copy link

github-actions bot commented Jul 22, 2025

🔍 Preview links for changed docs

Comment on lines 4 to 5
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

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

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.

Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

I agree that this isn't the spot for prescriptive guidance. This LGTM in the short term.

@karenzone
Copy link
Contributor

I was thinking short-term as well, while everything is new.

@theletterf theletterf merged commit 447e529 into main Jul 23, 2025
17 checks passed
@theletterf theletterf deleted the theletterf-patch-1 branch July 23, 2025 07:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants