diff --git a/content/(concepts)/design-system.mdx b/content/(concepts)/design-system.mdx new file mode 100644 index 00000000..0a644e71 --- /dev/null +++ b/content/(concepts)/design-system.mdx @@ -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. diff --git a/content/(concepts)/meta.ts b/content/(concepts)/meta.ts index 501d4f19..c9f8cda6 100644 --- a/content/(concepts)/meta.ts +++ b/content/(concepts)/meta.ts @@ -4,5 +4,5 @@ export default defineMeta({ title: "Concepts", collapsed: false, order: 2, - pages: ["spaces", "versions", "teams"], + pages: ["spaces", "versions", "teams", "design-system"], }); diff --git a/content/(concepts)/teams.mdx b/content/(concepts)/teams.mdx index 7f209620..b25c335d 100644 --- a/content/(concepts)/teams.mdx +++ b/content/(concepts)/teams.mdx @@ -11,6 +11,8 @@ After this page you can read the role table without guessing, invite and remove A team is the thing that owns work. Spaces, custom domains, API keys, billing, and members all hang off it. Every claimed Space belongs to exactly one team, even when you are its only member, so there is no separate personal container to reason about. +A team can also hold a [Design System](/design-system) for colors, type, voice, and brand files. Saving those standards does not change any Space until you apply them to its project. + A team has a name and a slug. The slug is the first segment of its dashboard URLs and you can change it in **Team settings → General**, where a live check tells you whether the new one is free. | Slug rule | Value | diff --git a/content/agents/index.mdx b/content/agents/index.mdx index 55ecfbc0..cb220d06 100644 --- a/content/agents/index.mdx +++ b/content/agents/index.mdx @@ -17,6 +17,8 @@ Anything you can do in the dashboard, an agent can do over MCP. The Spacefast MC Inside `execute`, search for an operation with `tools.search`, read its contract with `tools.describe`, then call it. Check each write with a read before reporting success. +If your team has a saved [Design System](/design-system), your agent can read its standards and files while working on a project. Ask it to apply the system to a new build or bring an existing project into line with the current rules. + Publish this folder to Spacefast and give me the live URL. diff --git a/content/agents/skills.mdx b/content/agents/skills.mdx index aa281d61..3f209cbc 100644 --- a/content/agents/skills.mdx +++ b/content/agents/skills.mdx @@ -1,11 +1,11 @@ --- title: Skills -description: The Spacefast agent skill, what it tells your agent to do, and how to install or remove it with the sf CLI +description: The base Spacefast skill and the task skills for saving and using a team's Design System --- -After this page you know what the shipped skill instructs your agent to do, which clients get which variant, and how to install, check, or remove it. +The base `spacefast` skill routes publishing and management work to the right tools. Spacefast plugins also include task skills for saving and using a team's Design System. -## One skill, called `spacefast` +## The base `spacefast` skill Every lane ships a skill named `spacefast`. It is two markdown files, `SKILL.md` and `references.md`, rendered from one template into per-client variants. @@ -18,7 +18,20 @@ Every lane ships a skill named `spacefast`. It is two markdown files, `SKILL.md` The plugin lanes carry the MCP variant, which routes work to the typed tools. The copy bundled with the CLI carries the curl and HTTP API variant instead, for agents that have no MCP connection at all. Same name, same product rules, different lane. -## What triggers it +## Design System task skills + +Spacefast plugins include four skills for the [Design System](/design-system): + +| Skill | Use it for | +|---|---| +| `import-design-system` | Save supplied standards, source files, and supporting guidance to the team | +| `apply-design-system` | Use saved standards in a new build or requested source edit | +| `verify-design-system` | Check a source build or preview against current standards; fix only when you ask for corrections | +| `update-design` | Bring a named existing Space or linked project onto current standards | + +Importing standards does not change a project. Applying them to one project does not roll them out to the team's other Spaces. + +## What triggers the base skill The trigger line is the frontmatter `description`. Your client matches it against what you asked for. @@ -65,7 +78,7 @@ Publish this folder to Spacefast and give me the live URL. Show me the deployments for this Space and whether the last build passed. -## What it instructs +## What the base skill instructs The skill's job is routing and conduct. The MCP variant follows these tool choices. @@ -90,9 +103,9 @@ The rest sets behavior the tools alone do not enforce. ## Kept in sync with the tools -A CI check re-renders every skill variant and compares the tool names it mentions against the live tool list, in both directions. A tool added without a skill update fails the build, and so does a skill that names a tool which no longer exists. The skill you install always names exactly the five tools the server registers. +A CI check re-renders every skill variant and compares the tool names it mentions against the live tool list, in both directions. A tool added without a skill update fails the build, and so does a skill that names a tool which no longer exists. The base skill names exactly the five tools the server registers. -## Install it on its own +## Install the base skill on its own If you want the skill without touching MCP config, the CLI installs the copy bundled with it. diff --git a/styles/Spacefast/spelling-exceptions.txt b/styles/Spacefast/spelling-exceptions.txt index 48251be6..5a6febe7 100644 --- a/styles/Spacefast/spelling-exceptions.txt +++ b/styles/Spacefast/spelling-exceptions.txt @@ -64,6 +64,7 @@ exif extensionless Favicon fetchable +Figma finalizer followable forwardable