Repository navigation
Document team Design Systems #67
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
alexanderaidun-a8c
wants to merge
3
commits into
main
Choose a base branch
from
codex/docs-design-system
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| --- | ||
| title: Design System | ||
| description: Save a team's design rules once, then reuse and check them across projects | ||
| --- | ||
|
|
||
| Save your team's colors, type, layout, voice, and brand files in one Design System. A connected agent can reuse those standards in a new project, check a build against them, or bring a named Space up to date. You choose which Spaces change. Saving the system alone does not edit or publish a site. | ||
|
|
||
| ## Start a Design System | ||
|
|
||
| When Design System is enabled for your team, open the team and choose **Design System**. If you see **Set up team context**, select it first. Then choose how to start: | ||
|
|
||
| - **Import what you already have.** Choose **Copy prompt** and give it to an agent connected to [Spacefast MCP](/agents). Give the agent your brand guide, Figma file, or repository too. The `import-design-system` skill saves supported values, registers source files, and keeps other guidance in supporting Memory records. Ask for a report of conflicts and anything it could not import. | ||
| - **Start from a kit.** Choose **shadcn/ui**, **Tailwind CSS**, or **Spacefast default**. The kit saves editable colors, type, and layout values. Review them before applying them to a project. | ||
|
|
||
| You can also add the standards yourself in the dashboard. **Look & feel** holds named colors, typography for headings and body text, and layout dimensions. **Voice** holds a tone description and writing rules with optional examples. | ||
|
|
||
| ## Add brand files | ||
|
|
||
| Use **Brand files** to upload logos, images, fonts, and source documents. After uploading, edit **How to use** to tell your agent where and when a file belongs. A filename alone cannot do that job. | ||
|
|
||
| Each upload must be no larger than 25 MB. Files stay in the team's private Media Library. Accepted SVG files are sanitized on upload, so check the saved artwork. An agent must download needed files and put visitor-facing assets in the project's source; private file URLs do not belong in a live page. | ||
|
|
||
| ## Apply it to a project | ||
|
|
||
| On a saved Design System, choose **Apply with your agent → Copy prompt**. Give the prompt to your connected agent and name the project or Space you want it to work on. The prompt points the agent to the current team standards and these skills when available: | ||
|
|
||
| - `apply-design-system` builds a new project or makes a requested source edit using the saved standards. | ||
| - `verify-design-system` checks a matching source build or preview and fixes gaps when you ask for corrections. | ||
| - `update-design` brings a named existing Space or linked project into line with the current standards. | ||
|
|
||
| The agent reads the saved Design System and applicable Memory, works from the complete project source, and checks the built result at desktop and mobile sizes. If a required file is unavailable or two rules conflict, it should report the specific gap. | ||
|
|
||
| Changes to team standards do not roll out to existing Spaces. Name each Space you want updated. Whether the agent publishes depends on your request and that Space's work mode. | ||
|
|
||
| ## Change or undo a saved rule | ||
|
|
||
| Edit the saved values in **Look & feel**, **Voice**, or **Brand files**. The **Changelog** shows the current revision and changes made in this session. **Revert** can undo only the latest saved change; older changes cannot be selected for undo. | ||
|
|
||
| If someone saves a newer revision while you are editing, reload the saved version and reconcile your draft before saving again. |
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -64,6 +64,7 @@ exif | |
| extensionless | ||
| Favicon | ||
| fetchable | ||
| Figma | ||
| finalizer | ||
| followable | ||
| forwardable | ||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟡 Bug · Docs say plugins ship Design System skills, but published plugins don't include them yet
This says Spacefast plugins include four Design System skills, but the published spacefast/plugins repo (HEAD d2cfc0f, release-manifest 0.5.1) only ships build-website, custom-domain, edit-space, fix-deployment, setup, share-space and spacefast.
import-design-system,apply-design-system,verify-design-systemandupdate-designexist only in the unreleased monorepo plugin source (0.6.0). Anyone installing the plugin today gets none of them, which breaks the repo rule to document only shipped, publicly verifiable behavior.Hold the PR until the plugin release is published, or reword to say the skills ship with an upcoming release. Also give the import step in design-system.mdx the same 'when available' wording the apply section uses.
Found by Indent Review Agent