UI Library docs: page-per-component + source-generated tables (3/3)#46
Open
librowski wants to merge 7 commits into
Open
UI Library docs: page-per-component + source-generated tables (3/3)#46librowski wants to merge 7 commits into
librowski wants to merge 7 commits into
Conversation
This was referenced Jun 24, 2026
librowski
requested review from
lukasz-jazwa,
piotrblaszczyk and
szymon-t-sc
as code owners
…tyle props/CSS tables Wrap every UI Library example in a shadow-DOM ComponentPreview so components are styled only by @workflowbuilder/ui (isolated from Starlight CSS), shown in a fixed 2:1 dotted preview box that matches the original Overflow UI docs. Collapse each example island to a single representative instance. Rework the generated Props and CSS-variable references from tables into card lists: props show a 'required' chip (required-first) instead of a line-wrapping '?' marker, with Type/Default/description rows; CSS variables group into Color/Size. Drop the now-unused example-frame styles.
Give the Edge, NodeIcon, NodeDescription and NodePanel pages the same shadow-DOM ComponentPreview the UI components use, rendering each as a standalone example (NodePanel compositions; EdgeLabel variants positioned relatively outside a canvas) for parity with the original Overflow UI docs. NodeAsPortWrapper stays props-only, matching the reference. Adds @phosphor-icons/react to the docs app for the example icons.
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.
Part 3 of 3. Stacked on #45 (base branch
librowski/ui-consumers) - review/merge #44 then #45 first. This PR's diff is only the documentation work.Summary
Builds the UI Library documentation in
apps/docs(Starlight): a page-per-component reference (twin to the old Overflow UI docs) with live interactive examples, props and CSS-variable tables generated from source (no hand-maintained tables), and a Design Tokens pipeline page.Changes
Docs site
@astrojs/react);@workflowbuilder/uistyles loaded via StarlightcustomCss(safe - no global reset; tokens follow the Starlight light/dark theme).@workflowbuilder/uion Base UI.Source-generated API tables
apps/docs/scripts/generate-ui-api.mjsruns TypeDoc over the@workflowbuilder/uibarrel to extract per-component props (type / required / default / description), and extracts--ax-public-*CSS variables from the stylesheets, into a git-ignoredui-api.json. Rendered inline viaPropsTable/CssVariablesTableAstro components. Wired into docsdev/build.@workflowbuilder/uibarrel, with@defaultJSDoc tags. This is the onlypackages/uichange in this PR and is additive.Design tokens
tokens.json(Figma) → Style Dictionary →--ax-*CSS pipeline, theming, customization, regeneration, and the known "missing token" gaps.Verification
build:docsgreen (177 pages); docstypecheckhas no errors in the new files (only the 4 pre-existinghead.astro/sidebar.astroerrors).Notes
overflow-card.astro) is intentionally left as-is (advertises the commercial product, not the vendored library).