mirror of https://github.com/nexu-io/open-design.git synced 2026-06-01 03:14:35 +07:00

refine typography-hierarchy craft docs — clarify edge cases and make lint measurable (#979 )

* add typography-hierarchy and typography-hierarchy-editorial craft rules

Adds two layered craft files extending typography.md:

- typography-hierarchy.md: core hierarchy contract, vectors, failure modes,
  controlled violations, and lint checklist
- typography-hierarchy-editorial.md: editorial pacing, dramatic scale jumps,
  whitespace hierarchy, display tracking overrides, and editorial-specific lint

Both files are registered in craft/README.md with guidance on when to require them.
Includes a new editorial stack example showing the layered opt-in pattern.

Validation:
- pnpm guard: PASSED
- Universal craft knowledge (not brand-specific)
- Stable slugs: typography-hierarchy, typography-hierarchy-editorial
- No new dependencies or breaking changes

Passes craft additions lane per code-review-guidelines.md.

* wire typography base into editorial skills craft stack

All three editorial skills now require the complete layered stack:
  [typography, typography-hierarchy, typography-hierarchy-editorial, rtl-and-bidi]

The new hierarchy files (typography-hierarchy.md, typography-hierarchy-editorial.md)
explicitly extend typography.md and depend on its base contract (scale ranges,
tracking values, line-height guidance, weight system). Without typography in
requires[], the hierarchy rules arrive at runtime without their foundational
contracts, making them incomplete.

Skills updated:
- skills/blog-post/SKILL.md
- skills/docs-page/SKILL.md
- skills/digital-eguide/SKILL.md

This completes the craft injection for the editorial stack as documented in
craft/README.md and ensures both base typography and hierarchy extensions load
together at runtime.

* refine craft docs for clarity and edge cases

Address P2/P3 reviewer feedback:

- typography-hierarchy-editorial.md §4: Add script-aware exception for Arabic/Hebrew/Persian
  tracking (cursive joining breaks with negative letter-spacing; use scale/space instead)

- typography-hierarchy.md Controlled violations: Add concrete safeguards for 'information
  flow remains intact' (reading order, proximity grouping, single primary, quick scanability)

- typography-hierarchy-editorial.md §2 Whitespace: Qualify 'no divider' rule to allow
  separators for publication identity, not just space alone

- typography-hierarchy-editorial.md Anti-patterns: Add docs-page carve-out for 'UI chrome'
  (functional controls in code/API blocks are OK; decorative badges belong outside measure)

- typography-hierarchy-editorial.md Lint: Make checks measurable — display/deck ratio >=1.5x,
  section spacing ratio rules (one gap >=1.5x baseline, another <=1.2x), separator identity
  check, and explicit guidance markers for auditability

* address P1/P2/P3 reviewer feedback: RTL conflicts, script accuracy, tracking scope, measurability

P1 — RTL physical-direction conflicts:
  - typography-hierarchy-editorial.md: Change 'ragged right' to 'text-align: start with
    ragged inline-end' for RTL compatibility
  - Separators in RTL: Add note on logical directions (inline-start/inline-end)
  - skills/digital-eguide/SKILL.md: Replace 'cover left, spread right' with
    'inline-start/inline-end' and 'pinned right-side' with 'pinned to inline-end'

P2 — Script-group accuracy:
  - Split script groups correctly: Arabic/Persian/Urdu cursive-joining (letter-spacing 0);
    Hebrew is RTL but not cursive-joining

P2 — Tracking exception scope:
  - Extend script exception to pull-quote tracking row (was only on display)
  - Mark both as Latin-only with joining-script carve-out

P2 — Primary-count inconsistency:
  - Clarify 'one at a time per visual region' with explicit long-form pacing resets note

P3 — Measurable lint:
  - Replace vague 'meaningfully larger' with >=1.5x baseline rhythm OR one token scale step

P3 — Orphaned reference:
  - Fix cross-ref to 'typography.md §letter-spacing' (was §display tracking)

P3 — Markdown typo:
  - Fix backtick nesting in '1.6–1.7' line-height range

* fix: RTL logical 'ragged' wording; make digital-eguide pull-quote script-aware; align section-separators lint with prose

* fix(P2): include Persian/Urdu in pull-quote script exception; remove 'space' from section-separators lint

* fix: align pull-quote bullet indentation in digital-eguide SKILL.md

* fix: align digital-eguide pull-quote bullet nesting

* fix: use logical pull-quote alignment wording in editorial craft

2026-05-09 08:13:35 +08:00

3.6 KiB

Raw Blame History

name

description

triggers

digital-eguide

A two-spread digital e-guide preview — page 1 is a cover (display title, author, "What's inside" stats, table of contents teaser); page 2 is a spread (lesson body with pull-quote and a step list). Lifestyle / creator brand tone. Use when the brief asks for an "e-guide", "digital guide", "lookbook", "lead magnet", "creator guide", "playbook", "PDF guide", or "电子指南".

e-guide

digital guide

lead magnet

lookbook

creator guide

playbook

pdf guide

ebook

电子指南

电子书

mode

platform

scenario

featured

preview

design_system

craft

example_prompt

prototype

desktop

marketing

type	entry
html	index.html

requires

sections

true

color

typography

layout

components

requires

typography

typography-hierarchy

typography-hierarchy-editorial

rtl-and-bidi

Design 'The Creator's Style & Format Guide' — cover page and one inside spread, lifestyle creator brand.

Digital E-Guide Skill

Produce a two-page digital guide preview side-by-side. Cover on the inline-start, inside spread on the inline-end. Lifestyle creator tone, lots of negative space, serif display headings, careful column rhythm.

Workflow

Read the active DESIGN.md (injected above). Pick a serif display token for the title (italic ligatures encouraged), a body serif for long-form, and a mono token for stats / labels.
Pick the topic + author from the brief. Generate a real title (e.g. "The Creator's Style & Format Guide"), a real subtitle, and a one-line author byline.
Layout — center two pages on a tinted backdrop:
- Page 1 — cover:
  - Eyebrow ("STYLE & FORMAT GUIDE FOR CREATORS").
  - Display title with mixed weights and one italic flourish word ("The Creator's Style & Format guide" — & and guide italic).
  - 3-cell stat row ("16 PRINCIPLES OF STYLE", "38 DOS & DON'TS", "1 BLOCK, ZERO TEMPLATES") in mono, separated by ·.
  - "What's inside" header with a 2-column TOC (chapters + page numbers in mono, leader dots).
  - Footer: "FIND YOUR VOICE" + page 01 mono.
  - Subtle decorative dot or sticker (CSS) in a corner.
- Page 2 — spread:
  - Eyebrow with chapter number + name ("CHAPTER 02 · TONE").
  - Display sub-title ("Write like you talk — only sharper.").
  - 2-column body: opening paragraph + a numbered 4-step list ("01 Pick the rule", "02 Drop the filler"…).
  - Pull-quote pinned to inline-end: for Latin scripts use large italic display and accent color; for Arabic, Persian, and Urdu use regular or light emphasis (no italics); for Hebrew use regular or light emphasis (no italics). Include attribution. (script-aware)
  - Bottom strip with "EXERCISE" callout (mono label + 1 sentence prompt in italic).
  - Footer: chapter title + page 18 mono.
Write a single HTML document:
- <!doctype html> through </html>, CSS inline.
- Pages are 600×860 paper-tone cards with 6px shadow, slight rotation opposing each other (±0.6deg) for a magazine-on-desk feel.
- data-od-id on cover, spread, toc, pull-quote, exercise.
Self-check:
- Type hierarchy is editorial — title owns page 1, sub-title owns page 2.
- Italic accent appears once per page.
- Mono used only for labels, stats, and TOC numbers.

Output contract

Emit between <artifact> tags:

<artifact identifier="eguide-slug" type="text/html" title="E-Guide — Title">
<!doctype html>
<html>...</html>
</artifact>

One sentence before the artifact, nothing after.

3.6 KiB Raw Blame History Unescape Escape

Digital E-Guide Skill

Workflow

Output contract

3.6 KiB

Raw Blame History