Skip to content

docs: Add design tokens reference and integration guides (Phase 1) - #5

Merged
waysnx-tech merged 1 commit into
mainfrom
waysnx-ui-kit-improvements
Oct 22, 2026
Merged

waysnx-tech merged 1 commit into
mainfrom
waysnx-ui-kit-improvements

Conversation

@krantighatpande

Copy link
Copy Markdown
Collaborator

Phase 1: Documentation + CSS Verification

Adds comprehensive documentation for WaysNX UI Kit design tokens and integration patterns.

Added

  • docs/theming/TOKENS.md - Complete design token reference (44 tokens, source-verified)
  • docs/integrations/EXISTING_APPS.md - Integration strategies with technically accurate CSS guidance

Changed

  • README.md - Updated Design System section with accurate token count

Verified

  • ✅ All 44 token values source-verified against packages/ui-core/src/styles/tokens.css
  • ✅ Token counts accurate (20 colors, 5 spacing, 8 typography, 4 radius, 5 shadows, 2 component)
  • ✅ CSS visual inspection in Storybook (all colors correct, no inconsistencies)
  • ✅ Storybook builds successfully
  • ✅ P0 regression tests pass (no regressions introduced)
  • ✅ Token inheritance verified in Button.css and Sidebar.css source

Technical Accuracy

  • CSS cascade layer documentation uses correct terminology (precedence, not specificity)
  • Font-size table shows actual var(--wx-accessibility-font-scale, 1) formulas
  • Integration guidance reflects actual build setup (tsup bundling)
  • Verification claims limited to sampled components

Scope

  • Documentation only (no code changes)
  • Phase 1 of incremental UI Kit improvements

Review Notes

This PR is approved for PR review. Merging and publishing will follow normal final checks.

Summary

Type

  • Bug fix
  • Accessibility
  • Security
  • Documentation
  • Performance
  • API change
  • Feature

Validation

  • Unit tests
  • Storybook
  • Playwright
  • Accessibility
  • Package/build

Documentation

  • README updated if needed
  • WDG metadata regenerated if needed

## Phase 1: Documentation + CSS Verification

Adds comprehensive documentation for WaysNX UI Kit design tokens and integration patterns.

### Added
- `docs/theming/TOKENS.md` - Complete design token reference (44 tokens, source-verified)
- `docs/integrations/EXISTING_APPS.md` - Integration strategies with technically accurate CSS guidance

### Changed
- `README.md` - Updated Design System section with accurate token count

### Verified
- ✅ All 44 token values source-verified against `packages/ui-core/src/styles/tokens.css`
- ✅ Token counts accurate (20 colors, 5 spacing, 8 typography, 4 radius, 5 shadows, 2 component)
- ✅ CSS visual inspection in Storybook (all colors correct, no inconsistencies)
- ✅ Storybook builds successfully
- ✅ P0 regression tests pass (no regressions introduced)
- ✅ Token inheritance verified in Button.css and Sidebar.css source

### Technical Accuracy
- CSS cascade layer documentation uses correct terminology (precedence, not specificity)
- Font-size table shows actual `var(--wx-accessibility-font-scale, 1)` formulas
- Integration guidance reflects actual build setup (tsup bundling)
- Verification claims limited to sampled components

### Scope
- Documentation only (no code changes)
- Phase 1 of incremental UI Kit improvements

### Review Notes
This PR is approved for PR review. Merging and publishing will follow normal final checks.
@krantighatpande
krantighatpande requested a review from a team as a code owner October 22, 2026 07:32

@waysnx-tech waysnx-tech 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.

Review: Approved

Reviewed the Phase 1 documentation changes for WaysNX UI Kit.

Verified

  • README updated with the correct 44-token reference and links to the new documentation.
  • Design token documentation and counts are consistent with the stated source verification.
  • CSS cascade-layer guidance correctly distinguishes cascade precedence from selector specificity.
  • Integration guidance reflects the documented build setup and clearly identifies the limitations of the Shadow DOM example.
  • Changes are appropriately scoped to documentation; no component logic changes are included.

Validation

  • Build and type-check: Passed.
  • Security and repository checks: Passed.
  • Dependency audit: Reports an advisory-only, non-blocking failure; review its findings separately.
  • Confirm Chromium, Firefox, and WebKit P0 regression jobs have passed before merging.

Recommendation: Approve and merge once the remaining regression-check statuses are confirmed. No further documentation changes are requested based on this review.

@waysnx-tech
waysnx-tech merged commit 8408723 into main Oct 22, 2026
7 checks passed
waysnx-tech pushed a commit that referenced this pull request Oct 29, 2026
- Add defaultExpandedIds?: string[] prop to MenuProps interface
- Initialize expanded state from prop using lazy useState
- Preserve existing behavior when prop is omitted
- Add 5 regression tests for default expansion functionality

Implements Phase 3 P1 #5 - Default Expanded Menu Items
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants