docs: align UI writing guidance with the new Kibana chrome (#4073)#6693
Open
florent-leborgne wants to merge 6 commits into
Open
docs: align UI writing guidance with the new Kibana chrome (#4073)#6693florent-leborgne wants to merge 6 commits into
florent-leborgne wants to merge 6 commits into
Conversation
Update the style guide to use the agreed naming for the new Kibana chrome (Side navigation, Sidebar, Application menu, Solution view, Classic navigation/view, Collapse navigation menu), refresh the "Referring to apps and pages" pattern, and adjust the Screenshots guidance for native drop shadows and the elements to exclude. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
Contributor
🔍 Preview links for changed docs |
Contributor
Vale Linting ResultsSummary: 2 warnings found
|
| File | Line | Rule | Message |
|---|---|---|---|
| contribute-docs/style-guide/ui-writing.md | 120 | Elastic.Spelling | 'Wireframe' is a possible misspelling. |
| contribute-docs/style-guide/ui-writing.md | 135 | Elastic.DirectionalLanguage | Don't use directional language. Use 'the preceding element' instead of 'the table above'. |
The Vale linter checks documentation changes against the Elastic Docs style guide.
To use Vale locally or report issues, refer to Elastic style guide for Vale.
…op Collapse row - Rename "Side navigation" to "Navigation menu" across the style guide and the two formatting.md examples. - Move "Solution view" and "Classic navigation / Classic view" under "Navigation menu" as nested entries. - Drop the "Collapse navigation menu" row. - Use plain "header" instead of "global header" in the Screenshots exclude list (no standardized name for the Kibana header). - Flag a wireframe diagram of the Kibana chrome as a needed asset for the new Naming section. Co-authored-by: Cursor <cursoragent@cursor.com>
- Adds a hand-built SVG wireframe of the Kibana chrome to the new Naming section, with regions labeled to match the table. - Expands the table to cover the full chrome: Banner, Global header, Secondary navigation, Application menu, App workspace, Flyout, alongside the existing Navigation menu / Solution view / Classic view / Sidebar entries. - Drops "Classic navigation" in favor of "Classic view" so the term mirrors the parent "Solution view" setting. - Adds a closing note that the table covers the main parts only; some elements have sub-parts that vary by interaction. Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
theletterf
approved these changes
May 26, 2026
Member
theletterf
left a comment
theletterf
left a comment
There was a problem hiding this comment.
Elastic Docs Skills updates required perhaps?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Note: intentionally tagged the 4 writing teams there so y'all have a change to look at this and weigh in on the changes
This PR addresses #4073 with the following changes:
contribute-docs/style-guide/ui-writing.md: adds a new Naming Kibana UI elements section that standardizes terminology for the Kibana chrome. The section includes a wireframe diagram of the chrome and a naming table covering Banner, Global header, Navigation menu (with Solution view and Classic view as nested entries), Secondary navigation, Application menu, App workspace, Flyout, and Sidebar. Also updates the Referring to apps and pages patterns to use "navigation menu" instead of "main menu", and refreshes the Screenshots guidance so writers know that native drop shadows in the new chrome are part of the product and that the navigation menu, breadcrumbs, header, application menu, and global search field are the elements to exclude from screenshots.contribute-docs/style-guide/images/kibana-chrome-layout.svg: a hand-built SVG wireframe of the Kibana chrome, used in the new Naming section.contribute-docs/style-guide/formatting.md: updates two illustrative examples that referenced "the main menu" to use "the navigation menu", so the style guide examples match the terminology it now teaches.Scope is limited to the style guide itself. Propagating the new wording (for example, every existing "Find ... in the main menu" sentence across the docs corpus) is intentionally left for follow-up PRs under #4911.
Resolves
Closes #4073