docs: add guide for building a design system - #3686
Open
Adebesin-Cell wants to merge 3 commits into
Open
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
@Adebesin-Cell is attempting to deploy a commit to the Chakra UI Team on Vercel. A member of the Team first needs to authorize it. |
Adebesin-Cell
marked this pull request as ready for review
July 24, 2026 09:12
…guide The design system guide (`panda lib` + `designSystem`) now owns the full shared-design-system workflow, so make the component library page defer to it. Keep the two cases it doesn't cover: shipping a preset, and shipping a static CSS file for apps that don't run Panda. Drop the superseded external-package (src files / build info) sections and FAQ, and point readers to the design system guide instead.
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
1 participant
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.
📝 Description
Adds a guide for building a design system as its own package and consuming it across apps — the
panda lib+designSystemworkflow. New page under Guides, listed in the sidebar.⛳️ Current behavior (updates)
The docs cover sharing styles through a preset, a static CSS file, or the build info file in the "Using Panda in a
component library" guide. There's no guide for the
panda lib+designSystemworkflow, and nothing documents that aconsumer generates only its own delta and re-exports the rest of the styled-system from the design system package.
🚀 New behavior
Adds
guides/design-systemand lists it in the sidebar. It walks the whole path:panda lib(which writes thedist/panda/artifacts and syncsyour
package.jsonexports).designSystemline, through the Vite plugin or PostCSS, including the entry CSS that puts thestyles on the page.
prefix, keep the Panda major in lockstep, and read the conflict and export diagnostics.The steps are grounded in the
sandbox-design-systemexample and a realpanda librun.💣 Is this a breaking change (Yes/No):
No. Docs only.