@lifeaitools/rdc-skills 0.24.38 → 0.24.41

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (196) hide show
  1. package/.claude/settings.json +15 -15
  2. package/.claude-plugin/marketplace.json +21 -21
  3. package/.claude-plugin/plugin.json +1371 -1371
  4. package/.github/workflows/publish.yml +34 -34
  5. package/.github/workflows/self-test.yml +58 -58
  6. package/CHANGELOG.md +310 -310
  7. package/LICENSE +21 -21
  8. package/MANIFEST.md +221 -221
  9. package/README.md +376 -375
  10. package/README.sandbox.md +3 -3
  11. package/RELEASE.md +42 -0
  12. package/assets/watcher/viewer.html +164 -164
  13. package/bin/rdc-skills-mcp.mjs +316 -316
  14. package/commands/build.md +183 -183
  15. package/commands/collab.md +180 -180
  16. package/commands/deploy.md +152 -152
  17. package/commands/design.md +31 -31
  18. package/commands/edit.md +28 -28
  19. package/commands/fixit.md +124 -124
  20. package/commands/handoff.md +173 -173
  21. package/commands/help.md +95 -95
  22. package/commands/overnight.md +220 -220
  23. package/commands/plan.md +158 -158
  24. package/commands/preplan.md +131 -131
  25. package/commands/prototype.md +145 -145
  26. package/commands/release.md +49 -49
  27. package/commands/report.md +99 -99
  28. package/commands/review.md +120 -120
  29. package/commands/self-test.md +113 -113
  30. package/commands/status.md +86 -86
  31. package/commands/watch.md +98 -98
  32. package/commands/workitems.md +137 -137
  33. package/git-sha.json +1 -1
  34. package/guides/agent-bootstrap.md +295 -295
  35. package/guides/agents/backend.md +104 -104
  36. package/guides/agents/content.md +94 -94
  37. package/guides/agents/cs2.md +56 -56
  38. package/guides/agents/data.md +87 -87
  39. package/guides/agents/design.md +77 -77
  40. package/guides/agents/frontend.md +92 -92
  41. package/guides/agents/infrastructure.md +81 -81
  42. package/guides/agents/setup.md +281 -281
  43. package/guides/agents/verify.md +151 -151
  44. package/guides/agents/viz.md +106 -106
  45. package/guides/backend.md +146 -146
  46. package/guides/content.md +147 -147
  47. package/guides/cs2.md +190 -190
  48. package/guides/data.md +123 -123
  49. package/guides/design.md +116 -116
  50. package/guides/engineering-behavior.md +43 -43
  51. package/guides/escalation-protocol.md +125 -125
  52. package/guides/frontend.md +151 -151
  53. package/guides/history-md-spec.md +297 -297
  54. package/guides/infrastructure.md +179 -179
  55. package/guides/lessons-learned-spec.md +151 -145
  56. package/guides/output-contract.md +108 -108
  57. package/guides/publish-md-spec.md +289 -289
  58. package/guides/rdc-skills-startup.md +30 -30
  59. package/guides/verify.md +11 -11
  60. package/hooks/check-cwd.js +31 -31
  61. package/hooks/check-rdc-environment.js +164 -164
  62. package/hooks/check-services.js +6 -6
  63. package/hooks/check-stale-work-items.js +19 -19
  64. package/hooks/foreground-process-gate.js +128 -128
  65. package/hooks/gate-watchdog-selfcheck.js +257 -257
  66. package/hooks/hook-logger.js +25 -25
  67. package/hooks/lib/run-evidence-gate.mjs +241 -241
  68. package/hooks/no-stop-open-epics.js +127 -127
  69. package/hooks/post-tool-batch-gate.js +203 -203
  70. package/hooks/post-work-check.js +21 -21
  71. package/hooks/postcompact-log.js +13 -13
  72. package/hooks/precompact-log.js +13 -13
  73. package/hooks/rate-limit-retry.js +46 -46
  74. package/hooks/rdc-invocation-marker.js +157 -157
  75. package/hooks/rdc-output-contract-gate.js +94 -94
  76. package/hooks/require-work-item-on-commit.js +294 -294
  77. package/hooks/restart-brief.js +19 -19
  78. package/hooks/run-hidden-hook.ps1 +47 -47
  79. package/hooks/task-completed-gate.js +274 -274
  80. package/hooks/work-item-exit-gate.js +944 -944
  81. package/lib/catalog.mjs +236 -236
  82. package/lib/cloud-rewrite.mjs +155 -155
  83. package/package.json +57 -56
  84. package/rules/work-items-rpc.md +520 -520
  85. package/scaffold/templates/HISTORY.md.template +39 -39
  86. package/scaffold/templates/PUBLISH.md.template +21 -21
  87. package/scaffold/templates/brochure-studio-default.html +70 -70
  88. package/scripts/acceptance.mjs +502 -502
  89. package/scripts/fixtures/guides/bad-guide.md +15 -15
  90. package/scripts/fixtures/guides-clean/good-guide.md +16 -16
  91. package/scripts/install-rdc-skills.js +1289 -1289
  92. package/scripts/install.ps1 +202 -202
  93. package/scripts/install.sh +132 -132
  94. package/scripts/lib/assertions.mjs +287 -287
  95. package/scripts/lib/manifest-schema.mjs +754 -754
  96. package/scripts/lib/runner.mjs +465 -465
  97. package/scripts/lib/sandbox.mjs +435 -435
  98. package/scripts/prepack.mjs +32 -32
  99. package/scripts/rdc-brochure.mjs +482 -464
  100. package/scripts/rdc-design-cli.mjs +134 -134
  101. package/scripts/rebuild-mcp.mjs +107 -107
  102. package/scripts/self-test.mjs +1460 -1460
  103. package/scripts/stamp-git-sha.mjs +29 -29
  104. package/scripts/test-guide-validator.mjs +196 -196
  105. package/scripts/test-rdc-hooks.mjs +145 -145
  106. package/scripts/uninstall.ps1 +77 -77
  107. package/scripts/uninstall.sh +69 -69
  108. package/scripts/update.ps1 +43 -43
  109. package/scripts/update.sh +43 -43
  110. package/scripts/validate-place-histories.js +461 -461
  111. package/scripts/validate-publish-manifests.js +424 -424
  112. package/scripts/watch-init.mjs +100 -100
  113. package/skills/brochure/SKILL.md +107 -107
  114. package/skills/build/SKILL.md +563 -563
  115. package/skills/channel-formatter/SKILL.md +533 -533
  116. package/skills/co-develop/SKILL.md +196 -196
  117. package/skills/collab/SKILL.md +239 -239
  118. package/skills/convert/SKILL.md +140 -140
  119. package/skills/deploy/SKILL.md +541 -541
  120. package/skills/design/SKILL.md +211 -211
  121. package/skills/design/reference/ownership.md +16 -16
  122. package/skills/design/reference/rampa.md +92 -92
  123. package/skills/design/reference/studio-model.md +153 -153
  124. package/skills/edit/SKILL.md +98 -98
  125. package/skills/fixit/SKILL.md +165 -165
  126. package/skills/fs-mcp/SKILL.md +148 -148
  127. package/skills/handoff/SKILL.md +236 -200
  128. package/skills/help/SKILL.md +143 -143
  129. package/skills/housekeeping/SKILL.md +219 -160
  130. package/skills/lifeai-brochure-author/SKILL.md +340 -340
  131. package/skills/overnight/SKILL.md +251 -251
  132. package/skills/plan/SKILL.md +345 -345
  133. package/skills/preplan/SKILL.md +90 -90
  134. package/skills/prototype/SKILL.md +150 -150
  135. package/skills/rdc-brochurify/SKILL.md +245 -245
  136. package/skills/rdc-extract-verifier-rules/SKILL.md +191 -191
  137. package/skills/release/SKILL.md +140 -140
  138. package/skills/report/SKILL.md +100 -100
  139. package/skills/review/SKILL.md +152 -152
  140. package/skills/rpms-filemap/SKILL.cloud.md +111 -111
  141. package/skills/rpms-filemap/SKILL.md +111 -111
  142. package/skills/self-test/SKILL.md +132 -132
  143. package/skills/status/SKILL.md +99 -99
  144. package/skills/terminal-config/SKILL.md +62 -62
  145. package/skills/tests/MATRIX.md +54 -54
  146. package/skills/tests/README.md +47 -47
  147. package/skills/tests/rdc-brochure.test.json +34 -34
  148. package/skills/tests/rdc-build.test.json +36 -36
  149. package/skills/tests/rdc-channel-formatter.test.json +45 -45
  150. package/skills/tests/rdc-co-develop.test.json +29 -29
  151. package/skills/tests/rdc-collab.test.json +29 -29
  152. package/skills/tests/rdc-convert.test.json +35 -35
  153. package/skills/tests/rdc-deploy.test.json +30 -30
  154. package/skills/tests/rdc-design.test.json +27 -27
  155. package/skills/tests/rdc-edit.test.json +29 -29
  156. package/skills/tests/rdc-fixit.test.json +36 -36
  157. package/skills/tests/rdc-fs-mcp.test.json +36 -36
  158. package/skills/tests/rdc-handoff.test.json +28 -28
  159. package/skills/tests/rdc-help.test.json +29 -29
  160. package/skills/tests/rdc-housekeeping.test.json +32 -28
  161. package/skills/tests/rdc-lifeai-brochure-author.test.json +35 -35
  162. package/skills/tests/rdc-overnight.test.json +37 -37
  163. package/skills/tests/rdc-plan.test.json +27 -27
  164. package/skills/tests/rdc-preplan.test.json +31 -31
  165. package/skills/tests/rdc-prototype.test.json +28 -28
  166. package/skills/tests/rdc-rdc-brochurify.test.json +23 -23
  167. package/skills/tests/rdc-rdc-extract-verifier-rules.test.json +34 -34
  168. package/skills/tests/rdc-release.test.json +29 -29
  169. package/skills/tests/rdc-report.test.json +28 -28
  170. package/skills/tests/rdc-review.test.json +29 -29
  171. package/skills/tests/rdc-rpms-filemap.test.json +28 -28
  172. package/skills/tests/rdc-self-test.test.json +24 -24
  173. package/skills/tests/rdc-status.test.json +29 -29
  174. package/skills/tests/rdc-terminal-config.test.json +29 -29
  175. package/skills/tests/rdc-watch.test.json +24 -24
  176. package/skills/tests/rdc-workitems.test.json +27 -27
  177. package/skills/watch/SKILL.md +97 -97
  178. package/skills/workitems/SKILL.md +151 -151
  179. package/tests/acceptance.test.mjs +59 -59
  180. package/tests/channel-formatter.contract.test.mjs +251 -251
  181. package/tests/curl-surface.test.mjs +289 -289
  182. package/tests/harness-gates.test.mjs +325 -325
  183. package/tests/help-surface.test.mjs +61 -61
  184. package/tests/housekeeping-lessons-triage.test.mjs +49 -0
  185. package/tests/install-rdc-skills.test.mjs +49 -49
  186. package/tests/lessons-pipeline-contract.test.mjs +26 -0
  187. package/tests/manifest-contract-fields.test.mjs +78 -78
  188. package/tests/mcp.test.mjs +271 -271
  189. package/tests/rdc-brochure.test.mjs +125 -0
  190. package/tests/release-contract.test.mjs +16 -0
  191. package/tests/require-work-item-on-commit.test.mjs +162 -162
  192. package/tests/run-evidence-gate.test.mjs +82 -82
  193. package/tests/skill-test-matrix.test.mjs +66 -66
  194. package/tests/validate-skills.js +27 -27
  195. package/tests/work-item-exit-gate-l2.test.mjs +368 -368
  196. package/tests/work-item-exit-gate-l3.test.mjs +197 -197
@@ -1,340 +1,340 @@
1
- ---
2
- name: lifeai-brochure-author
3
- version: 0.1.0
4
- description: |
5
- The mandatory contract for authoring brochure JSX using @lifeai/brochure-kit. Use this skill EVERY TIME any AI engine (Claude, Cursor, Copilot, /design, Cowork, v0) generates JSX intended for the Brochurify pipeline — whether the user says "write a brochure," "make a one-pager," "draft a PDF report," or any equivalent. Also trigger when a file imports from @lifeai/brochure-kit. Failing to read this skill before authoring is a defect.
6
-
7
- triggers:
8
- - "write a brochure"
9
- - "make a one-pager"
10
- - "draft a PDF report"
11
- - "design a brochure"
12
- - "create an investor doc"
13
- - "generate a fact sheet"
14
- - "brochurify"
15
- - "@lifeai/brochure-kit"
16
- - any JSX file under apps/*/brochures/ or packages/brochure-*/
17
-
18
- required_validators:
19
- - command: pnpm bk-lint
20
- blocking: true
21
- ---
22
-
23
- # LIFEAI Brochure Authoring Contract
24
- > **⚠️ OUTPUT CONTRACT (READ FIRST):** `guides/output-contract.md`
25
- > Return the authored JSX guidance or verification result directly; do not dump raw tool logs.
26
-
27
- This is the contract every AI engine obeys when generating brochure JSX. The contract is non-negotiable. If you cannot generate output that complies, **stop and ask for clarification rather than emit non-compliant code.**
28
-
29
- ## The Core Rule
30
-
31
- Every brochure is a tree composed exclusively of components from `@lifeai/brochure-kit`. Raw HTML elements (`div`, `span`, `section`, etc.) are forbidden in the page tree. There are no exceptions.
32
-
33
- ```tsx
34
- // ❌ WRONG
35
- <div className="flex flex-col gap-4">
36
- <h1 style={{color: '#2d5a3f'}}>Title</h1>
37
- <p>Body text...</p>
38
- </div>
39
-
40
- // ✅ RIGHT
41
- <Stack gap="md">
42
- <Heading level={1} variant="accent">Title</Heading>
43
- <Prose>Body text...</Prose>
44
- </Stack>
45
- ```
46
-
47
- If you find yourself reaching for a `<div>`, the answer is one of: `<Stack>`, `<Cluster>`, `<Section>`, `<Columns>`, or `<Brochure>`. There is always a kit primitive for what you want.
48
-
49
- ## The Allowed Components
50
-
51
- Exactly these. No others.
52
-
53
- ### Layout primitives
54
- - `<Brochure>` — root wrapper. Required. Carries `theme`, `pageSize`, `mode`.
55
- - `<Page>` — explicit page boundary. Use sparingly; prefer Sections.
56
- - `<Section>` — semantic grouping. Carries `level`, `id`, `affinity`.
57
- - `<Cluster>` — tightly-coupled children (heading + intro + image). Stays together when possible.
58
- - `<Stack>` — loose vertical flow. The default container.
59
- - `<Columns>` — multi-column block. Carries `count`, `gap`.
60
- - `<Spacer>` — explicit air. Declared in named sizes only.
61
-
62
- ### Content primitives
63
- - `<Prose>` — body text. Wraps paragraphs. Required for any flowing copy.
64
- - `<Heading>` — section heading. Carries `level` (1-6), `variant`.
65
- - `<Quote>` — pull quote. Carries `attribution`, `variant`.
66
- - `<Stat>` — single numeric callout. Carries `value`, `label`, `variant`.
67
- - `<StatRow>` — horizontal band of Stats. Carries `count`.
68
- - `<DataTable>` — table. Carries `headers`, `rows`, `splitPolicy`.
69
- - `<List>` — typed list. Carries `kind` (bullet, number, check, none).
70
- - `<Definition>` — term + definition pair.
71
-
72
- ### Visual primitives
73
- - `<Figure>` — image with caption. Carries `src`, `alt`, `caption`, `width`, `height`, `crop`, `bleed`.
74
- - `<Hero>` — page-anchored hero. Carries `src`, `alt`, `placement`.
75
- - `<Divider>` — explicit separator. Carries `variant`.
76
-
77
- ### Meta primitives
78
- - `<Cover>` — first page, page-locked.
79
- - `<TableOfContents>` — auto-generated from `<Heading>`s.
80
- - `<Footnote>` — page-anchored footnote. Carries `id`, `marker`.
81
-
82
- ## The Allowed HTML (inside `<Prose>` only)
83
-
84
- Inside `<Prose>`, these inline HTML elements are allowed:
85
- - `<em>`, `<strong>` — emphasis
86
- - `<a>` — links (with `href`)
87
- - `<code>` — inline code
88
- - `<sub>`, `<sup>` — subscript/superscript
89
- - `<br>` — line break (use sparingly)
90
-
91
- Anything else inside `<Prose>` is rejected.
92
-
93
- ## The Forbidden Patterns
94
-
95
- These are hard-rejected by the validator. Do not emit them under any circumstance.
96
-
97
- 1. **Raw layout HTML** — `<div>`, `<span>`, `<section>`, `<article>`, `<aside>`, `<header>`, `<footer>`, `<nav>` outside of `<Prose>`.
98
- 2. **Inline styles** — `style={{...}}` on any element. Use variant props instead.
99
- 3. **Color literals** — Hex codes, rgb(), hsl() in JSX. Use theme tokens via variants.
100
- 4. **Viewport units** — `vh`, `vw`, `vmin`, `vmax` anywhere. Pages have fixed dimensions; viewport units break pagination.
101
- 5. **Flexbox utility classes** — `flex`, `flex-col`, `justify-*`, `items-*` directly in className. Use kit primitives that handle layout.
102
- 6. **Tailwind sizing literals** — `w-64`, `h-32`, `min-h-screen`. Use kit props.
103
- 7. **Empty containers** — `<Stack></Stack>` with no children is rejected. Use `<Spacer>` for explicit air.
104
- 8. **Nested `<Page>`** — Pages cannot contain Pages.
105
- 9. **`<Figure>` without dimensions** — Every Figure must declare `width` and `height` (in inches or as a kit named size: `xs`, `sm`, `md`, `lg`, `xl`, `full`, `bleed`).
106
- 10. **External CSS imports** — No `import './foo.css'` in brochure files. Theming is via tokens.
107
-
108
- ## The Required Props
109
-
110
- Every brochure must:
111
-
112
- 1. Have exactly one `<Brochure>` root wrapper
113
- 2. Declare `theme` on `<Brochure>` (one of: `prt`, `place-fund`, `zoen`, `evergreen`, `editorial-neutral`)
114
- 3. Declare `pageSize` on `<Brochure>` (one of: `letter`, `a4`, `legal`, `digest`, `tabloid`)
115
- 4. Declare `mode` on `<Brochure>` (one of: `read-only`, `cosmetic`, `editorial`, `creative`)
116
-
117
- ## The Token System
118
-
119
- All styling derives from `@lifeai/brochure-tokens`. You reference tokens via variant props, never via raw values.
120
-
121
- ```tsx
122
- // ✅ Variant references resolve to tokens
123
- <Heading variant="accent">...</Heading> // → color: token.color.accent
124
- <Stat variant="emphasis">...</Stat> // → typography.scale.emphasis
125
- <Stack gap="md">...</Stack> // → spacing.scale.md
126
- <Figure width="lg" height="md">...</Figure> // → kit-named sizes
127
-
128
- // ❌ Literal references fail
129
- <Heading style={{color: '#2d5a3f'}}>...</Heading> // hard-rejected
130
- <Stack style={{gap: '24px'}}>...</Stack> // hard-rejected
131
- ```
132
-
133
- Available variant tokens depend on the theme. Common ones: `default`, `muted`, `accent`, `accent2`, `emphasis`, `serif`, `mono`. The theme file (in `packages/brochure-tokens/src/themes/`) is the authoritative list.
134
-
135
- ## Pagination Affinities
136
-
137
- Components declare how they want to paginate. You don't manage page breaks manually except via `<Page>`. The engine does it.
138
-
139
- | Component | Default affinity |
140
- |---|---|
141
- | `<Heading level=1|2>` | `preferTopOfPage` + `keepWithNext` |
142
- | `<Heading level=3-6>` | `keepWithNext` |
143
- | `<Cluster>` | `preferKeepTogether` |
144
- | `<Stack>` | `breakable` |
145
- | `<Quote>` | `preferKeepTogether` |
146
- | `<Stat>`, `<StatRow>` | `atomic` (never split) |
147
- | `<DataTable>` | `splitWithRepeatedHeaders` (min 3 rows per fragment) |
148
- | `<Figure>` | `keepWithCaption` |
149
- | `<Hero>` | `preferStandalone` page |
150
- | `<Footnote>` | sticks to anchor page |
151
-
152
- You can override per-instance with the `affinity` prop on most components: `affinity="breakable"`, `affinity="keepTogether"`, `affinity="hardBreakBefore"`, `affinity="hardBreakAfter"`, `affinity="preferStandalone"`.
153
-
154
- ## Worked Example 1: Investor One-Pager (Read-Only Mode)
155
-
156
- ```tsx
157
- import {
158
- Brochure, Cover, Section, Cluster, Stack, Heading, Prose,
159
- Stat, StatRow, Figure, Footnote
160
- } from '@lifeai/brochure-kit';
161
-
162
- export const PrtOnePager = () => (
163
- <Brochure theme="prt" pageSize="letter" mode="read-only">
164
- <Cover>
165
- <Heading level={1} variant="accent">Planetary Regenerative Trust</Heading>
166
- <Heading level={3} variant="muted">Q3 2026 Fund Update</Heading>
167
- <Figure
168
- src="prt-cover.jpg"
169
- alt="Aerial view of Sky Mesa South Ranch"
170
- width="bleed"
171
- height="lg"
172
- affinity="preferStandalone"
173
- />
174
- </Cover>
175
-
176
- <Section level={1} id="overview">
177
- <Heading level={2}>Fund Overview</Heading>
178
- <StatRow count={3}>
179
- <Stat value="$200M" label="Target raise" variant="emphasis" />
180
- <Stat value="506(c)" label="Reg D structure" />
181
- <Stat value="3" label="Investment lanes" />
182
- </StatRow>
183
- <Cluster>
184
- <Heading level={3}>Five Capitals Framework</Heading>
185
- <Prose>
186
- PRT operates across the Five Capitals: <strong>Natural, Social,
187
- Financial, Built, and Human</strong>. Capital flows are gated by
188
- place-readiness rather than calendar deadlines<Footnote id="fn1" />.
189
- </Prose>
190
- </Cluster>
191
- </Section>
192
-
193
- <Section level={1} id="lanes">
194
- <Heading level={2}>Investment Lanes</Heading>
195
- <Prose>
196
- Three lanes accept capital with distinct return profiles, hold
197
- periods, and risk parameters.
198
- </Prose>
199
- </Section>
200
-
201
- <Footnote id="fn1" marker="1">
202
- Readiness gates are defined per-place by Story of Place methodology and
203
- reviewed by an independent stewardship council.
204
- </Footnote>
205
- </Brochure>
206
- );
207
- ```
208
-
209
- Things to notice:
210
- - No `<div>` anywhere. Every container is a kit primitive.
211
- - No styles. Every visual decision is a variant prop.
212
- - The Figure on the cover declares `width="bleed"` (a kit-named size that resolves to full bleed at PDF time)
213
- - The Footnote is declared inline and the actual footnote content is at the end; the engine pairs them and places the content on whatever page the anchor lands on.
214
- - `affinity="preferStandalone"` on the cover Figure ensures the cover image doesn't fight with body content on page 1.
215
-
216
- ## Worked Example 2: Why-Us Document (Cosmetic Mode)
217
-
218
- ```tsx
219
- import {
220
- Brochure, Cover, Section, Stack, Cluster, Heading, Prose, Quote,
221
- Figure, List, Definition, Divider
222
- } from '@lifeai/brochure-kit';
223
-
224
- export const WhyUsSkyMesa = () => (
225
- <Brochure theme="place-fund" pageSize="letter" mode="cosmetic">
226
- <Cover>
227
- <Heading level={1}>Why Us</Heading>
228
- <Heading level={3} variant="muted">Sky Mesa South Ranch · Aspen, Colorado</Heading>
229
- </Cover>
230
-
231
- <Section level={1}>
232
- <Heading level={2}>The Land Speaks First</Heading>
233
- <Prose>
234
- Before any framework or fund structure, we begin with the question:
235
- what is this place already trying to become? Sky Mesa South Ranch sits
236
- in the Roaring Fork watershed, on land with five generations of
237
- ranching memory and the deep ecological imprint of high-altitude
238
- montane ecosystems.
239
- </Prose>
240
- <Figure
241
- src="sky-mesa-aerial.jpg"
242
- alt="Sky Mesa from the eastern ridge"
243
- caption="Sky Mesa South Ranch, photographed in late summer 2025"
244
- width="lg"
245
- height="md"
246
- />
247
- </Section>
248
-
249
- <Divider variant="rule" />
250
-
251
- <Section level={1}>
252
- <Heading level={2}>Five Capitals at Sky Mesa</Heading>
253
- <List kind="check">
254
- <Definition term="Natural">Watershed restoration, riparian recovery, soil regeneration</Definition>
255
- <Definition term="Social">Multi-generational ranching community, Indigenous consultation</Definition>
256
- <Definition term="Financial">PRT Lane B with conservation easement layer</Definition>
257
- <Definition term="Built">Adaptive reuse of existing ranching infrastructure</Definition>
258
- <Definition term="Human">On-site stewardship apprenticeships starting Year 1</Definition>
259
- </List>
260
- </Section>
261
-
262
- <Section level={1}>
263
- <Quote attribution="Bill Reed, AIA LEED">
264
- Regeneration is not a technology applied to a place. It is a
265
- relationship a place enters into with the people who tend it.
266
- </Quote>
267
- </Section>
268
- </Brochure>
269
- );
270
- ```
271
-
272
- ## Worked Example 3: Fact Sheet (Read-Only Mode, Dense)
273
-
274
- ```tsx
275
- import {
276
- Brochure, Section, Stack, Heading, Prose,
277
- DataTable, StatRow, Stat
278
- } from '@lifeai/brochure-kit';
279
-
280
- export const FundFactSheet = () => (
281
- <Brochure theme="prt" pageSize="letter" mode="read-only">
282
- <Section level={1}>
283
- <Heading level={1} variant="accent">PRT Fund Fact Sheet</Heading>
284
- <Heading level={3} variant="muted">As of Q3 2026</Heading>
285
- </Section>
286
-
287
- <Section level={2}>
288
- <Heading level={2}>Performance</Heading>
289
- <StatRow count={4}>
290
- <Stat value="$185M" label="Committed capital" />
291
- <Stat value="$92M" label="Deployed" />
292
- <Stat value="12" label="Active places" />
293
- <Stat value="8.4%" label="Net IRR (LTM)" variant="emphasis" />
294
- </StatRow>
295
- </Section>
296
-
297
- <Section level={2}>
298
- <Heading level={2}>Capital by Lane</Heading>
299
- <DataTable
300
- headers={["Lane", "Commitment", "Deployed", "Net IRR"]}
301
- rows={[
302
- ["A — Production", "$80M", "$48M", "10.2%"],
303
- ["B — Place Capital", "$70M", "$32M", "7.8%"],
304
- ["C — Stewardship", "$35M", "$12M", "5.4%"],
305
- ]}
306
- splitPolicy="repeat-headers"
307
- />
308
- </Section>
309
- </Brochure>
310
- );
311
- ```
312
-
313
- ## Pre-Flight Checklist (Run before considering output complete)
314
-
315
- Before declaring any brochure JSX done, verify:
316
-
317
- - [ ] Only kit components in the page tree (no raw `<div>`, `<span>`, etc.)
318
- - [ ] No `style={{}}` attributes anywhere
319
- - [ ] No color, rgb, hsl literals in JSX
320
- - [ ] No `vh`, `vw` viewport units
321
- - [ ] Every `<Figure>` has `width` and `height`
322
- - [ ] Exactly one `<Brochure>` root
323
- - [ ] `theme`, `pageSize`, `mode` all set on `<Brochure>`
324
- - [ ] All Quotes inside `<Quote>` (not raw HTML)
325
- - [ ] All flowing text inside `<Prose>`
326
- - [ ] No empty containers
327
- - [ ] No nested `<Page>`
328
- - [ ] Run `pnpm bk-lint <file>` — exit code 0
329
-
330
- If any check fails, fix it before completing. The validator is the contract; this skill is the lookup table.
331
-
332
- ## When Things Get Hard
333
-
334
- If you genuinely cannot express something in kit primitives, **stop and surface the gap.** Don't reach for `<div>`. Either:
335
-
336
- 1. The kit needs a new component (file as a Phase-2 enhancement)
337
- 2. The content is wrong for this format (push back on the user)
338
- 3. There's a kit primitive you missed (re-read this skill)
339
-
340
- The first two are honorable. Reaching for `<div>` is not.
1
+ ---
2
+ name: lifeai-brochure-author
3
+ version: 0.1.0
4
+ description: |
5
+ The mandatory contract for authoring brochure JSX using @lifeai/brochure-kit. Use this skill EVERY TIME any AI engine (Claude, Cursor, Copilot, /design, Cowork, v0) generates JSX intended for the Brochurify pipeline — whether the user says "write a brochure," "make a one-pager," "draft a PDF report," or any equivalent. Also trigger when a file imports from @lifeai/brochure-kit. Failing to read this skill before authoring is a defect.
6
+
7
+ triggers:
8
+ - "write a brochure"
9
+ - "make a one-pager"
10
+ - "draft a PDF report"
11
+ - "design a brochure"
12
+ - "create an investor doc"
13
+ - "generate a fact sheet"
14
+ - "brochurify"
15
+ - "@lifeai/brochure-kit"
16
+ - any JSX file under apps/*/brochures/ or packages/brochure-*/
17
+
18
+ required_validators:
19
+ - command: pnpm bk-lint
20
+ blocking: true
21
+ ---
22
+
23
+ # LIFEAI Brochure Authoring Contract
24
+ > **⚠️ OUTPUT CONTRACT (READ FIRST):** `guides/output-contract.md`
25
+ > Return the authored JSX guidance or verification result directly; do not dump raw tool logs.
26
+
27
+ This is the contract every AI engine obeys when generating brochure JSX. The contract is non-negotiable. If you cannot generate output that complies, **stop and ask for clarification rather than emit non-compliant code.**
28
+
29
+ ## The Core Rule
30
+
31
+ Every brochure is a tree composed exclusively of components from `@lifeai/brochure-kit`. Raw HTML elements (`div`, `span`, `section`, etc.) are forbidden in the page tree. There are no exceptions.
32
+
33
+ ```tsx
34
+ // ❌ WRONG
35
+ <div className="flex flex-col gap-4">
36
+ <h1 style={{color: '#2d5a3f'}}>Title</h1>
37
+ <p>Body text...</p>
38
+ </div>
39
+
40
+ // ✅ RIGHT
41
+ <Stack gap="md">
42
+ <Heading level={1} variant="accent">Title</Heading>
43
+ <Prose>Body text...</Prose>
44
+ </Stack>
45
+ ```
46
+
47
+ If you find yourself reaching for a `<div>`, the answer is one of: `<Stack>`, `<Cluster>`, `<Section>`, `<Columns>`, or `<Brochure>`. There is always a kit primitive for what you want.
48
+
49
+ ## The Allowed Components
50
+
51
+ Exactly these. No others.
52
+
53
+ ### Layout primitives
54
+ - `<Brochure>` — root wrapper. Required. Carries `theme`, `pageSize`, `mode`.
55
+ - `<Page>` — explicit page boundary. Use sparingly; prefer Sections.
56
+ - `<Section>` — semantic grouping. Carries `level`, `id`, `affinity`.
57
+ - `<Cluster>` — tightly-coupled children (heading + intro + image). Stays together when possible.
58
+ - `<Stack>` — loose vertical flow. The default container.
59
+ - `<Columns>` — multi-column block. Carries `count`, `gap`.
60
+ - `<Spacer>` — explicit air. Declared in named sizes only.
61
+
62
+ ### Content primitives
63
+ - `<Prose>` — body text. Wraps paragraphs. Required for any flowing copy.
64
+ - `<Heading>` — section heading. Carries `level` (1-6), `variant`.
65
+ - `<Quote>` — pull quote. Carries `attribution`, `variant`.
66
+ - `<Stat>` — single numeric callout. Carries `value`, `label`, `variant`.
67
+ - `<StatRow>` — horizontal band of Stats. Carries `count`.
68
+ - `<DataTable>` — table. Carries `headers`, `rows`, `splitPolicy`.
69
+ - `<List>` — typed list. Carries `kind` (bullet, number, check, none).
70
+ - `<Definition>` — term + definition pair.
71
+
72
+ ### Visual primitives
73
+ - `<Figure>` — image with caption. Carries `src`, `alt`, `caption`, `width`, `height`, `crop`, `bleed`.
74
+ - `<Hero>` — page-anchored hero. Carries `src`, `alt`, `placement`.
75
+ - `<Divider>` — explicit separator. Carries `variant`.
76
+
77
+ ### Meta primitives
78
+ - `<Cover>` — first page, page-locked.
79
+ - `<TableOfContents>` — auto-generated from `<Heading>`s.
80
+ - `<Footnote>` — page-anchored footnote. Carries `id`, `marker`.
81
+
82
+ ## The Allowed HTML (inside `<Prose>` only)
83
+
84
+ Inside `<Prose>`, these inline HTML elements are allowed:
85
+ - `<em>`, `<strong>` — emphasis
86
+ - `<a>` — links (with `href`)
87
+ - `<code>` — inline code
88
+ - `<sub>`, `<sup>` — subscript/superscript
89
+ - `<br>` — line break (use sparingly)
90
+
91
+ Anything else inside `<Prose>` is rejected.
92
+
93
+ ## The Forbidden Patterns
94
+
95
+ These are hard-rejected by the validator. Do not emit them under any circumstance.
96
+
97
+ 1. **Raw layout HTML** — `<div>`, `<span>`, `<section>`, `<article>`, `<aside>`, `<header>`, `<footer>`, `<nav>` outside of `<Prose>`.
98
+ 2. **Inline styles** — `style={{...}}` on any element. Use variant props instead.
99
+ 3. **Color literals** — Hex codes, rgb(), hsl() in JSX. Use theme tokens via variants.
100
+ 4. **Viewport units** — `vh`, `vw`, `vmin`, `vmax` anywhere. Pages have fixed dimensions; viewport units break pagination.
101
+ 5. **Flexbox utility classes** — `flex`, `flex-col`, `justify-*`, `items-*` directly in className. Use kit primitives that handle layout.
102
+ 6. **Tailwind sizing literals** — `w-64`, `h-32`, `min-h-screen`. Use kit props.
103
+ 7. **Empty containers** — `<Stack></Stack>` with no children is rejected. Use `<Spacer>` for explicit air.
104
+ 8. **Nested `<Page>`** — Pages cannot contain Pages.
105
+ 9. **`<Figure>` without dimensions** — Every Figure must declare `width` and `height` (in inches or as a kit named size: `xs`, `sm`, `md`, `lg`, `xl`, `full`, `bleed`).
106
+ 10. **External CSS imports** — No `import './foo.css'` in brochure files. Theming is via tokens.
107
+
108
+ ## The Required Props
109
+
110
+ Every brochure must:
111
+
112
+ 1. Have exactly one `<Brochure>` root wrapper
113
+ 2. Declare `theme` on `<Brochure>` (one of: `prt`, `place-fund`, `zoen`, `evergreen`, `editorial-neutral`)
114
+ 3. Declare `pageSize` on `<Brochure>` (one of: `letter`, `a4`, `legal`, `digest`, `tabloid`)
115
+ 4. Declare `mode` on `<Brochure>` (one of: `read-only`, `cosmetic`, `editorial`, `creative`)
116
+
117
+ ## The Token System
118
+
119
+ All styling derives from `@lifeai/brochure-tokens`. You reference tokens via variant props, never via raw values.
120
+
121
+ ```tsx
122
+ // ✅ Variant references resolve to tokens
123
+ <Heading variant="accent">...</Heading> // → color: token.color.accent
124
+ <Stat variant="emphasis">...</Stat> // → typography.scale.emphasis
125
+ <Stack gap="md">...</Stack> // → spacing.scale.md
126
+ <Figure width="lg" height="md">...</Figure> // → kit-named sizes
127
+
128
+ // ❌ Literal references fail
129
+ <Heading style={{color: '#2d5a3f'}}>...</Heading> // hard-rejected
130
+ <Stack style={{gap: '24px'}}>...</Stack> // hard-rejected
131
+ ```
132
+
133
+ Available variant tokens depend on the theme. Common ones: `default`, `muted`, `accent`, `accent2`, `emphasis`, `serif`, `mono`. The theme file (in `packages/brochure-tokens/src/themes/`) is the authoritative list.
134
+
135
+ ## Pagination Affinities
136
+
137
+ Components declare how they want to paginate. You don't manage page breaks manually except via `<Page>`. The engine does it.
138
+
139
+ | Component | Default affinity |
140
+ |---|---|
141
+ | `<Heading level=1|2>` | `preferTopOfPage` + `keepWithNext` |
142
+ | `<Heading level=3-6>` | `keepWithNext` |
143
+ | `<Cluster>` | `preferKeepTogether` |
144
+ | `<Stack>` | `breakable` |
145
+ | `<Quote>` | `preferKeepTogether` |
146
+ | `<Stat>`, `<StatRow>` | `atomic` (never split) |
147
+ | `<DataTable>` | `splitWithRepeatedHeaders` (min 3 rows per fragment) |
148
+ | `<Figure>` | `keepWithCaption` |
149
+ | `<Hero>` | `preferStandalone` page |
150
+ | `<Footnote>` | sticks to anchor page |
151
+
152
+ You can override per-instance with the `affinity` prop on most components: `affinity="breakable"`, `affinity="keepTogether"`, `affinity="hardBreakBefore"`, `affinity="hardBreakAfter"`, `affinity="preferStandalone"`.
153
+
154
+ ## Worked Example 1: Investor One-Pager (Read-Only Mode)
155
+
156
+ ```tsx
157
+ import {
158
+ Brochure, Cover, Section, Cluster, Stack, Heading, Prose,
159
+ Stat, StatRow, Figure, Footnote
160
+ } from '@lifeai/brochure-kit';
161
+
162
+ export const PrtOnePager = () => (
163
+ <Brochure theme="prt" pageSize="letter" mode="read-only">
164
+ <Cover>
165
+ <Heading level={1} variant="accent">Planetary Regenerative Trust</Heading>
166
+ <Heading level={3} variant="muted">Q3 2026 Fund Update</Heading>
167
+ <Figure
168
+ src="prt-cover.jpg"
169
+ alt="Aerial view of Sky Mesa South Ranch"
170
+ width="bleed"
171
+ height="lg"
172
+ affinity="preferStandalone"
173
+ />
174
+ </Cover>
175
+
176
+ <Section level={1} id="overview">
177
+ <Heading level={2}>Fund Overview</Heading>
178
+ <StatRow count={3}>
179
+ <Stat value="$200M" label="Target raise" variant="emphasis" />
180
+ <Stat value="506(c)" label="Reg D structure" />
181
+ <Stat value="3" label="Investment lanes" />
182
+ </StatRow>
183
+ <Cluster>
184
+ <Heading level={3}>Five Capitals Framework</Heading>
185
+ <Prose>
186
+ PRT operates across the Five Capitals: <strong>Natural, Social,
187
+ Financial, Built, and Human</strong>. Capital flows are gated by
188
+ place-readiness rather than calendar deadlines<Footnote id="fn1" />.
189
+ </Prose>
190
+ </Cluster>
191
+ </Section>
192
+
193
+ <Section level={1} id="lanes">
194
+ <Heading level={2}>Investment Lanes</Heading>
195
+ <Prose>
196
+ Three lanes accept capital with distinct return profiles, hold
197
+ periods, and risk parameters.
198
+ </Prose>
199
+ </Section>
200
+
201
+ <Footnote id="fn1" marker="1">
202
+ Readiness gates are defined per-place by Story of Place methodology and
203
+ reviewed by an independent stewardship council.
204
+ </Footnote>
205
+ </Brochure>
206
+ );
207
+ ```
208
+
209
+ Things to notice:
210
+ - No `<div>` anywhere. Every container is a kit primitive.
211
+ - No styles. Every visual decision is a variant prop.
212
+ - The Figure on the cover declares `width="bleed"` (a kit-named size that resolves to full bleed at PDF time)
213
+ - The Footnote is declared inline and the actual footnote content is at the end; the engine pairs them and places the content on whatever page the anchor lands on.
214
+ - `affinity="preferStandalone"` on the cover Figure ensures the cover image doesn't fight with body content on page 1.
215
+
216
+ ## Worked Example 2: Why-Us Document (Cosmetic Mode)
217
+
218
+ ```tsx
219
+ import {
220
+ Brochure, Cover, Section, Stack, Cluster, Heading, Prose, Quote,
221
+ Figure, List, Definition, Divider
222
+ } from '@lifeai/brochure-kit';
223
+
224
+ export const WhyUsSkyMesa = () => (
225
+ <Brochure theme="place-fund" pageSize="letter" mode="cosmetic">
226
+ <Cover>
227
+ <Heading level={1}>Why Us</Heading>
228
+ <Heading level={3} variant="muted">Sky Mesa South Ranch · Aspen, Colorado</Heading>
229
+ </Cover>
230
+
231
+ <Section level={1}>
232
+ <Heading level={2}>The Land Speaks First</Heading>
233
+ <Prose>
234
+ Before any framework or fund structure, we begin with the question:
235
+ what is this place already trying to become? Sky Mesa South Ranch sits
236
+ in the Roaring Fork watershed, on land with five generations of
237
+ ranching memory and the deep ecological imprint of high-altitude
238
+ montane ecosystems.
239
+ </Prose>
240
+ <Figure
241
+ src="sky-mesa-aerial.jpg"
242
+ alt="Sky Mesa from the eastern ridge"
243
+ caption="Sky Mesa South Ranch, photographed in late summer 2025"
244
+ width="lg"
245
+ height="md"
246
+ />
247
+ </Section>
248
+
249
+ <Divider variant="rule" />
250
+
251
+ <Section level={1}>
252
+ <Heading level={2}>Five Capitals at Sky Mesa</Heading>
253
+ <List kind="check">
254
+ <Definition term="Natural">Watershed restoration, riparian recovery, soil regeneration</Definition>
255
+ <Definition term="Social">Multi-generational ranching community, Indigenous consultation</Definition>
256
+ <Definition term="Financial">PRT Lane B with conservation easement layer</Definition>
257
+ <Definition term="Built">Adaptive reuse of existing ranching infrastructure</Definition>
258
+ <Definition term="Human">On-site stewardship apprenticeships starting Year 1</Definition>
259
+ </List>
260
+ </Section>
261
+
262
+ <Section level={1}>
263
+ <Quote attribution="Bill Reed, AIA LEED">
264
+ Regeneration is not a technology applied to a place. It is a
265
+ relationship a place enters into with the people who tend it.
266
+ </Quote>
267
+ </Section>
268
+ </Brochure>
269
+ );
270
+ ```
271
+
272
+ ## Worked Example 3: Fact Sheet (Read-Only Mode, Dense)
273
+
274
+ ```tsx
275
+ import {
276
+ Brochure, Section, Stack, Heading, Prose,
277
+ DataTable, StatRow, Stat
278
+ } from '@lifeai/brochure-kit';
279
+
280
+ export const FundFactSheet = () => (
281
+ <Brochure theme="prt" pageSize="letter" mode="read-only">
282
+ <Section level={1}>
283
+ <Heading level={1} variant="accent">PRT Fund Fact Sheet</Heading>
284
+ <Heading level={3} variant="muted">As of Q3 2026</Heading>
285
+ </Section>
286
+
287
+ <Section level={2}>
288
+ <Heading level={2}>Performance</Heading>
289
+ <StatRow count={4}>
290
+ <Stat value="$185M" label="Committed capital" />
291
+ <Stat value="$92M" label="Deployed" />
292
+ <Stat value="12" label="Active places" />
293
+ <Stat value="8.4%" label="Net IRR (LTM)" variant="emphasis" />
294
+ </StatRow>
295
+ </Section>
296
+
297
+ <Section level={2}>
298
+ <Heading level={2}>Capital by Lane</Heading>
299
+ <DataTable
300
+ headers={["Lane", "Commitment", "Deployed", "Net IRR"]}
301
+ rows={[
302
+ ["A — Production", "$80M", "$48M", "10.2%"],
303
+ ["B — Place Capital", "$70M", "$32M", "7.8%"],
304
+ ["C — Stewardship", "$35M", "$12M", "5.4%"],
305
+ ]}
306
+ splitPolicy="repeat-headers"
307
+ />
308
+ </Section>
309
+ </Brochure>
310
+ );
311
+ ```
312
+
313
+ ## Pre-Flight Checklist (Run before considering output complete)
314
+
315
+ Before declaring any brochure JSX done, verify:
316
+
317
+ - [ ] Only kit components in the page tree (no raw `<div>`, `<span>`, etc.)
318
+ - [ ] No `style={{}}` attributes anywhere
319
+ - [ ] No color, rgb, hsl literals in JSX
320
+ - [ ] No `vh`, `vw` viewport units
321
+ - [ ] Every `<Figure>` has `width` and `height`
322
+ - [ ] Exactly one `<Brochure>` root
323
+ - [ ] `theme`, `pageSize`, `mode` all set on `<Brochure>`
324
+ - [ ] All Quotes inside `<Quote>` (not raw HTML)
325
+ - [ ] All flowing text inside `<Prose>`
326
+ - [ ] No empty containers
327
+ - [ ] No nested `<Page>`
328
+ - [ ] Run `pnpm bk-lint <file>` — exit code 0
329
+
330
+ If any check fails, fix it before completing. The validator is the contract; this skill is the lookup table.
331
+
332
+ ## When Things Get Hard
333
+
334
+ If you genuinely cannot express something in kit primitives, **stop and surface the gap.** Don't reach for `<div>`. Either:
335
+
336
+ 1. The kit needs a new component (file as a Phase-2 enhancement)
337
+ 2. The content is wrong for this format (push back on the user)
338
+ 3. There's a kit primitive you missed (re-read this skill)
339
+
340
+ The first two are honorable. Reaching for `<div>` is not.