Skip to content

Render hub get-started steps as chevrons - #4247

Merged
florent-leborgne merged 5 commits into
mainfrom
flb/get-started-chevrons
Oct 6, 2026
Merged

florent-leborgne merged 5 commits into
mainfrom
flb/get-started-chevrons

Conversation

@florent-leborgne

@florent-leborgne florent-leborgne commented Sep 29, 2026 •

Copy link
Copy Markdown
Member

The {get-started} section draws its steps as chevrons, so a hub's onboarding reads as one numbered path.

Affects: Site UI

Prompt summary: Implement the light chevron layout for the hub get-started section, as a draft pull request on this repository. Keep the command a code block with a copy button, take type from the site scale, and keep the hub arrow. Bring the command chip and the step title closer to that layout.

Why

This change is an attempt to give some more visual substance to the get started sections of hub pages. The current look has too many lines and degrades the readability of the page.

What

Before
image

After
image

This layout is responsive:

  • chevron blocks become regular blocs that stack vertically when the screen reduces
  • the layout accommodates several scenarios with different numbers of steps and different number of rows, as well as blocks with "forks" (This OR That) in any position)

I ran some contrast tests to ensure this works well too. But design refinements more than welcome, I dislike the current more than i like this new proposal, so, happy to get better ideas and input, I just feel we need to change the current :)

On the authoring side, this shouldn't impact the content that has to be added using the directive.

Chevron rows

Each step is a chevron filled with blue-elastic-10 and outlined with a grey-70 hairline, numbered from 1. Steps after a fork share the row, three across when the count divides by three and two when it is even. A step alone on its row stays one cell wide and is centered. Each row continues the list count, and a line joins one row to the next.

Two choices in one step

A step with two options takes the full row as one chevron. The choices sit side by side, split by "or". A URL with no command renders as a button. A command that also has a URL, and a step link, stay text links with the hub arrow. The chevron itself is not the link. That fork layout is used only when the step has exactly two options.

Command chip

An option command stays a standard code block, so highlighting and the copy button remain. The box hugs the command and matches the button in height and corner radius. The command uses --text-xs and the step title uses --text-lg. Option names, descriptions, and text links stay on --text-base, and the button stays on --text-sm.

Narrow width

The section queries its own width, because the sidebar narrows the body. Below 720px the steps stack to full width and the chevron shape drops. The content in each step is centered. The joining line is hidden at that width.

Authoring contract

The YAML schema is unchanged. The syntax page at docs/syntax/get-started.md describes the chevron rows, the centered lone step, the centered stacked content, and the text link.

Verify

dotnet test tests/Elastic.Authoring.Tests/
./dev.sh serve

Open the docs-builder hub example. Check a forked first step, a row of three, a lone centered step, and the column below 720px. Confirm the command chip matches the option button and that the other links still use the hub arrow.

A card grid made the forked first step look like another box, and a lone step stretched across the row. Chevrons keep the sequence readable, keep the trial action a button, and center a step that sits alone.

Co-authored-by: Cursor <cursoragent@cursor.com>
@github-actions

Copy link
Copy Markdown
Contributor

Docs preview (local build)

Handbook preview: https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/4247/

Sample changed pages:

An option command stays a code block, so highlighting and the copy button remain. The chip now hugs the command and shares the button height, and the step title steps up one size on the type scale.

Co-authored-by: Cursor <cursoragent@cursor.com>
@florent-leborgne florent-leborgne added redesign Frontend visual or structural redesign and removed enhancement labels Sep 29, 2026
Below 720px each step is a plain block. The badge, text, links, button, and command now sit in the horizontal center of that block.

Co-authored-by: Cursor <cursoragent@cursor.com>
@florent-leborgne
florent-leborgne marked this pull request as ready for review September 29, 2026 20:01
@florent-leborgne
florent-leborgne requested a review from a team as a code owner September 29, 2026 20:01

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Requesting changes based on the blocking issues documented in the inline comments.


What is this? | From workflow: PR Review

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

Comment thread src/Elastic.Markdown/Myst/Directives/Hub/GetStartedView.cshtml Outdated
Comment thread src/Elastic.Markdown/Myst/Directives/Hub/GetStartedView.cshtml Outdated
florent-leborgne and others added 2 commits September 29, 2026 23:32
A screen reader was restarting at 1 on each row, because the badge is hidden and each row was its own list. The fork grid now applies only when a step has two options.

Co-authored-by: Cursor <cursoragent@cursor.com>

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Approved.


What is this? | From workflow: PR Review

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

@bmorelli25 bmorelli25 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nice

@georgewallace georgewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I like the new look

@florent-leborgne
florent-leborgne merged commit 7c7c2eb into main Oct 6, 2026
36 checks passed
@florent-leborgne
florent-leborgne deleted the flb/get-started-chevrons branch October 6, 2026 18:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

redesign Frontend visual or structural redesign

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants