agentleFS
phazurlabsphazurlabs/sumi/skills/design-memory/SKILL.md

design-memory

Skill58 starsChanged 23 days agoApache-2.0View on GitHub

The .sumi/ design memory contract — which files exist, the canonical style.json schema, which command owns which subtree, read order, and merge rules. Use whenever a command reads or writes .sumi/, or when design decisions from an earlier command must survive into a later one.

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

3 rules. About 0 are common, 2 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Absent is not empty: No file means "not decided yet" — generate a value and offer to persist it.

    line 114
  2. Very specific:

    Never invent a token when style.json exists: If the palette is on disk, use it.

    line 117
  3. Distinctive:

    Conflict: ask once: If your write would change a value another command set in a previous session, surface both values in one line and ask.

    line 120

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Design Memory — the .sumi/ contract

.sumi/ is what makes the commands compose. /style decides a visual direction once; /screen, /component, /page, /fix and a dozen others consume it instead of re-inventing a palette every invocation.

That only works if every command agrees on the file shape. Until v4.1.0 none was written down, and four commands wrote .sumi/style.json in four different shapes while other commands read whichever they assumed. This skill is the single definition.

Constants

The canonical .sumi/style.json. Every writer emits this envelope; nobody invents keys.

{
  "$sumi": "1",
  "meta": {
    "generated": "ISO-8601 timestamp",
    "updatedBy": ["/style"],
    "sector": "fintech",
    "mood": "professional",
    "platform": "web"
  },
  "project": {
    "framework": "react | vue | svelte | vanilla | swiftui",
    "styling": "tailwind | css | styled-components | swiftui",
    "typescript": true
  },
  "tokens": {
    "$schema": "https://design-tokens.github.io/community-group/format/",
    "color": {},
    "typography": {},
    "space": {},
    "radius": {},
    "shadow": {},
    "duration": {},
    "easing": {},
    "z": {},
    "$themes": { "light": {}, "dark": {} }
  },
  "tone": {
    "formality": "",
    "traits": [],
    "wordsToUse": [],
    "wordsToAvoid": []
  },
  "references": [
    { "app": "", "platform": "", "stealThis": "", "takeaway": "" }
  ]
}

Everything under tokens is W3C DTCG. Everything outside it is Sumi's own envelope, because DTCG has no way to express a sector, a tone of voice, or a list of reference apps.

The file set

FileWritten byHolds
.sumi/style.json/style, /palette, /type, /tokens, /darkthe schema above
.sumi/brief.json/briefpersona, HMW questions, constraints, success criteria
.sumi/map.json/mapsitemap, screen inventory, content hierarchy
.sumi/vision.json/gradevisual direction, designer-DNA match, score
.sumi/wireframe-<screen>.json/wireframelayout structure, component map
.sumi/generated-<asset>.json/generategeneration records, prompts, model, score
.sumi/refs//insposourced references, captures, board.json. Schema in reference-intelligence/references/board-synthesis.md
.sumi/decisions.logany commandappend-only NDJSON: {ts, command, decision, reason, overrides}

Ownership

A writer touches its own subtree and nothing else. This is what allows four commands to share one file without clobbering each other.

CommandOwns
/stylethe whole file — it is the only command that may create it
/palettetokens.color
/typetokens.typography
/tokenstokens.* (serialization only; it does not decide)
/darktokens.$themes.dark
/inspo.sumi/refs/ only
everything elseread-only

Read order

Broad to specific. Later files override earlier ones where they overlap.

  1. brief.json — who it is for and what problem it solves
  2. map.json — what screens exist
  3. refs/board.json — what the references say it should look like
  4. style.json — what it looks like (the decision; wins over the board)
  5. vision.json — the visual bar and DNA match
  6. wireframe-<screen>.json — the layout of the screen actually in play
  7. decisions.log — the running override log; the last entry wins

Merge rules

  1. Read-modify-write, never replace. Load the file, deep-merge your subtree, write it back. Append your command name to meta.updatedBy and refresh meta.generated. A whole-file replacement destroys three other commands' work and is the specific bug this contract exists to prevent.
  2. Precedence: explicit user instruction > design memory > defaults. An instruction in the current turn wins immediately and appends to decisions.log with its reason.
  3. Absent is not empty. No file means "not decided yet" — generate a value and offer to persist it. A file present but partial means "decided" for the sections that exist; fill only the gaps.
  4. Never invent a token when style.json exists. If the palette is on disk, use it. Inventing a second palette mid-session is the most visible way to break the illusion that the commands are one system.
  5. Conflict: ask once. If your write would change a value another command set in a previous session, surface both values in one line and ask. Do not ask twice in a session, and do not silently overwrite.

Routing

For the full JSON Schema of every file, worked merge examples, and the migration note for pre-v4.1.0 files: read references/sumi-file-schemas.md.

Cross-References

  • design-systems-architecture — the DTCG token tiers tokens serializes
  • design-token-presets — vetted starting token sets to seed tokens from
  • sumi-orchestrator — pipelines that span several commands, which is when design memory earns its keep

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.