fix: quote build script path & improve color token documentation#9417
Draft
ragini-pandey wants to merge 3 commits intoelastic:mainfrom
Draft
fix: quote build script path & improve color token documentation#9417ragini-pandey wants to merge 3 commits intoelastic:mainfrom
ragini-pandey wants to merge 3 commits intoelastic:mainfrom
Conversation
…n notices, and semantic guidance
|
👋 Since this is a community submitted pull request, a Buildkite build has not been started automatically. Would an Elastic organization member please verify the contents of this pull request and kick off a build manually? |
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
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
This PR fixes a build script path quoting issue and improves the color token documentation across the EUI website.
Build fix: The
execSynccall incompile-eui.jsthat invokesdtsgenerator.jsdid not quote the resolved path, causing the build to fail when the workspace directory contains spaces. The fix wraps the path in quotes.Documentation improvements: Added descriptions to all color token tables (text, background, border, shade, special, data vis, severity), improved introductory copy with clearer semantic token guidance, added deprecation notices for shade/special tokens and legacy palette functions, fixed a typo in
backgroundBaseSkeletonMiddle, fixed a brokenDataVisBackgroundColorimport in the severity patterns page, and improved color palette utilities documentation.Why are we making this change?
Closes #8540
compile-eui.jsis a latent bug that surfaces whenever a developer clones the repo into a directory whose path contains spaces.Screenshots #
N/A — Documentation text changes only; no visual/UI component changes.
Impact to users
No breaking changes. The build script fix is internal tooling. The documentation improvements provide better guidance for EUI consumers using color tokens, especially around deprecated shade/special tokens and their semantic replacements.
QA
General checklist
Checked in both light and dark modes(no UI changes)Checked in both MacOS and Windows high contrast modes(no UI changes)Checked in mobile(no UI changes)Checked in Chrome, Safari, Edge, and Firefox(no UI changes)Checked for accessibility including keyboard-only and screenreader modes(no UI changes)Props have proper autodocs(no prop changes)Checked Code Sandbox works for any docs examples(no interactive examples added)Added or updated jest and cypress tests(documentation-only changes)Updated visual regression tests(no visual changes)If applicable, added the breaking change issue label(no breaking changes)If the changes unblock an issue in a different repo, smoke tested carefully(N/A)If applicable, file an issue to update EUI's Figma library(no UI changes)