Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fix: quote build script path & improve color token documentation#9417

Draft
ragini-pandey wants to merge 3 commits intoelastic:mainfrom
ragini-pandey:fix/docs-color-tokens-and-build-path
Draft

fix: quote build script path & improve color token documentation#9417
ragini-pandey wants to merge 3 commits intoelastic:mainfrom
ragini-pandey:fix/docs-color-tokens-and-build-path

Conversation

@ragini-pandey
Copy link
Contributor

@ragini-pandey ragini-pandey commented Feb 28, 2026

Summary

This PR fixes a build script path quoting issue and improves the color token documentation across the EUI website.

Build fix: The execSync call in compile-eui.js that invokes dtsgenerator.js did 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 broken DataVisBackgroundColor import in the severity patterns page, and improved color palette utilities documentation.

Why are we making this change?

Closes #8540

  1. Build script fix — The unquoted path in compile-eui.js is a latent bug that surfaces whenever a developer clones the repo into a directory whose path contains spaces.
  2. Color token docs — The existing color token documentation pages had empty description fields in all token tables, making it harder for consumers to understand the intended use of each token. Deprecation notices were also missing for shade and special tokens that have semantic replacements.

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

  • Browser QA
    • 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)
  • Docs site QA
    • Added documentation — improved color token descriptions and page copy
    • Props have proper autodocs (no prop changes)
    • Checked Code Sandbox works for any docs examples (no interactive examples added)
  • Code quality checklist
    • Added or updated jest and cypress tests (documentation-only changes)
    • Updated visual regression tests (no visual changes)
  • Release checklist
    • A changelog entry exists and is marked appropriately
    • 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)
  • Designer checklist
    • If applicable, file an issue to update EUI's Figma library (no UI changes)

@github-actions
Copy link

👋 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?

@github-actions github-actions bot added the community contribution (Don't delete - used for automation) label Feb 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community contribution (Don't delete - used for automation)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update color page documentation based on Borealis color palette changes

1 participant