docs(brand): DESIGN.md house-style layer + AI-guide wiring#88
Merged
Conversation
reframe had no shared brand layer, so every scene re-declared its own palette and the AI generator invented a fresh one each time. Add DESIGN.md at the root (the design-tokens convention coding agents read), naming the de-facto values already used across the scenes as canonical: primary accent #FF4D00, secondary #00C2A8, bg #0A0C14, fg #FFFFFF, Inter type scale, and a Balanced motion tone (easeOutCubic base, easeOutBack entrances, energy 0.5), plus an audio palette. Motion-first, since reframe's brand spans easing/duration/energy and sound, not just color and type. Wire it into the generation surface so generated scenes follow it: a compact "Brand / house style" section in the eDSL guide (printed by `reframe guide`, bundled in npm) and a house-style fallback note in the plugin skill. A user-supplied brief always overrides the defaults. Docs only, no engine change (golden-safe). This is Phase 0 of a design-layer roadmap; a theme()/token-in-code layer and an IR-level overlay-addressable theme are deliberate later phases. Bumps the plugin to 0.1.12 (the SKILL.md edit requires it). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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.
Phase 0 of a design-layer roadmap. Docs only, no engine change (golden-safe).
Why
reframe has no shared brand layer, so every scene re-declares its own palette (
gradient-demo.ts:14,annual-report.ts:18, …) and the AI generator invents a fresh one each time it writes a scene. Research surfaced theDESIGN.mdconvention (machine-readable tokens + rationale that coding agents read to stay on-brand) and the W3C design-tokens spec (which now includes a motion category).What
DESIGN.mdat the repo root, naming the de-facto values already used across the scenes as canonical: primary accent#FF4D00, secondary#00C2A8, bg#0A0C14, fg#FFFFFF, the Inter type scale, a Balanced motion tone (easeOutCubicbase,easeOutBackentrances,energy 0.5), and the bgm/sfx palette. Motion-first, since reframe's brand spans easing/duration/energy and sound, not just color/type.docs/guides/edsl-guide.mdgets a compact "Brand / house style" section (printed byreframe guide, bundled in npm) so generated scenes follow the brand.plugin/skills/reframe/SKILL.mdgets a house-style fallback note; a user-supplied brief always overrides.0.1.11→0.1.12(required by the SKILL.md edit).Out of scope (later phases)
Phase 1 = a
theme()tokens-in-code layer + refactor scenes to use it. Phase 2 = an IR-levelSceneIR.designfield, overlay-addressable, withrender --themeand per-brandbatch. Every token in DESIGN.md is traceable to a real source (e.g.titles.ts:113for the#FF4D00lowerThird default), no invented values.Verification
reframe guideprints the new Brand section;typecheckclean; a frame still renders (engine unchanged); no em-dash, no commercial-product name in the doc.Note: the skill reaches marketplace users on push; an npm/Agent-SDK consumer loading the bundled skill would pick this up on the next
reframe-videopublish (optional).🤖 Generated with Claude Code