agentleFS
app-vitalsapp-vitals/shipwright/.claude/skills/shipwright-brand/SKILL.md

shipwright-brand

Skill16 starsChanged 24 days agoMITView on GitHub

This skill MUST activate whenever creating, editing, or reviewing ANY Shipwright Harness marketing or brand artifact — e.g. "make a Shipwright one-pager", "create a Shipwright Harness slide deck", "design the OG / social image", "build an on-brand landing-page section", "Shipwright marketing material", "is this on-brand?", "generate a Shipwright PDF/deck", or when editing anything under `brand/`, the marketing website, or `brand/templates/`. It enforces the locked design system in `brand/BRAND.md` + `brand/tokens.json` so every artifact (website, one-pager, deck, video slides, social card, PDF) is on-brand by construction, not by memory.

The file

We split this skill into the rules it gives an agent

1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    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. Very specific:

    Read brand/BRAND.md for the full system (color roles, type scale, logo/mark rules, component patterns, OG spec).

    line 61

≈ “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

shipwright-brand skill

Purpose

Produce on-brand Shipwright Harness marketing artifacts by deriving everything from the locked brand system — never by hand-picking colors, fonts, or copy. The system lives in:

  • brand/tokens.json — canonical machine-readable tokens (colors, type scale, radii, gradients). The single source of truth.
  • brand/BRAND.md — the human narrative: voice, logo rules, component patterns, content rules.
  • brand/brand.css — generated stylesheet (CSS custom properties + utility classes) derived from tokens.json.
  • brand/templates/ — starting points: one-pager.html, deck.html, social-card.html.

The lock (non-negotiable)

  1. Never write a raw hex, font name, or radius into an artifact. Use brand.css variables (var(--sw-color-brand-default)) and utility classes (.sw-btn, .sw-card, .sw-callout, .sw-pill, .sw-container, .sw-display, .sw-label, .sw-gradient-text).
  2. If you need a value, read it from tokens.json — don't recall it from memory.
  3. Green #34C77B is the hero; Patriot navy #002244 is a support surface (never link text); #4F8EF7 is the readable blue. CTAs are green-fill / navy-text. Body copy uses --sw-color-text-body (80%), not the 50% editorial tone.

Workflow (every artifact)

  1. Refresh the stylesheet so it matches current tokens: bun brand/build-brand-css.ts → writes brand/brand.css.
  2. Start from the matching template in brand/templates/ (copy it; don't author from scratch).
  3. Fill content following the voice + hard content rules below. Keep the brand-vs-package naming rule.
  4. Lint the result — fails on any off-palette color: bun brand/brand-lint.ts <your-file.html> → fix every flagged hex (replace with a token/variable).
  5. For a single-file deliverable (PDF, email, embedded): inline brand/brand.css into a <style> block so the artifact is self-contained. For a PDF: open the HTML and print to PDF (or bunx playwright screenshot). For an OG/social PNG: screenshot the .og element at exactly 1280×640.

Modes

ModeTemplateOutput
One-pagerbrand/templates/one-pager.htmlSelf-contained HTML → PDF (dev- or leader-facing)
Slide deckbrand/templates/deck.htmlFull-viewport slides; also the source for video slides
Social / OGbrand/templates/social-card.html1280×640 PNG (link previews, announcements)
Web componentbrand.css variables + utility classesOn-brand section/snippet for the marketing site (map tokens into the site's Tailwind config)

Hard content rules (from BRAND.md §5 — every public artifact)

  • No client / customer / partner names. Anonymize by role or industry.
  • No pricing, rates, or tiers. The tool is free/MIT; services are discussed in conversation, never published.
  • No email-capture forms. The only off-page CTA is the discovery call: https://vitals-os.com/cal/book/discovery.
  • No secrets, internal infra identifiers, or local file paths — this repo is public.
  • Naming: brand = Shipwright Harness; package/install = shipwright (run /plugin marketplace add app-vitals/shipwright, then, as a separate command, /plugin install shipwright@shipwright). Never headline "shipwright" lowercase; never write the brand name as a command.
  • Voice: honest, direct, engineer-to-engineer, metric-first. No hype, no emoji-laden superlatives.

Reference

Read brand/BRAND.md for the full system (color roles, type scale, logo/mark rules, component patterns, OG spec). Change a token in brand/tokens.json → re-run step 1 → every artifact follows. Never hardcode a value that exists as a token.

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.