SKILL.md
OpenPress
Use this skill first for OpenPress CLI and delivery work.
Route
| Need | Skill |
|---|---|
| Page artifact creation | openpress-create-pages |
| Slide creation or editing | openpress-create-slide |
| Authored-content analysis, proposal, or revision | openpress-collaborate |
Pending @openpress-comment markers |
openpress-apply-comments |
| External plugins (diagrams, visual tools, writing helpers) | openpress-plugins |
| Package upgrade or migration | openpress-upgrade |
| Deploy or publish | openpress-deploy |
Load portable language or genre skills only when the content requires them.
Source Boundary
| Layer | Paths | Rule |
|---|---|---|
| Workspace source | press/*/press.tsx, registered MDX/TSX sources, press/<slug>/{components,theme,media}/, optional press/shared/, press/design.md, openpress/settings.json |
editable |
| Skill source | skills/, .agents/skills/, .claude/skills/ |
editable for skill work |
| Framework source | packages/core/, packages/cli/, apps/web/, root config/docs/tests |
framework work only |
| Review handoff | .openpress/review/current.json |
openpress-collaborate may replace or delete; never deliver or commit |
| Installed framework | node_modules/@open-press/{core,cli}/ |
read-only; fix upstream |
| Generated/cache | public/openpress/, dist-react/, .deploy/, other .openpress/, .turbo/cache/ |
never hand-edit |
openpress/settings.json owns workspace Appearance, page defaults, caption numbering, PDF filename, and deploy configuration. Press visual design remains in press/design.md and each Press theme.
If memory/AGENTS.md exists, read it first; it identifies a downstream workspace and its project rules.
Local Review Gate
After content, layout, component, Press Tree, or pagination-sensitive theme changes:
npm run build
npm run dev # downstream workspace
# npm run dev:workspace # framework dogfood repo
Open Vite's /workspace and inspect the affected Press for page count, overflow/cropping, pagination, typography/media, and pending comments. Fix source and repeat when needed.
Export only a requested delivery format, after local Workbench review:
npm run openpress:pdf
npm run openpress:image
npm run openpress:word
PDF/image/Word export does not replace Workbench review.
Refresh Boundary
Vite HMR does not regenerate public/openpress/<slug>/document.json. After MDX, Press Tree, component, metadata, or pagination-sensitive theme edits, run npm run build before reviewing. For a faster inner loop, run open-press export . and refresh the browser. Pure CSS edits that do not move content may use HMR alone.
CLI And References
- Prefer package scripts. Downstream commands without a wrapper use
open-press; the framework repo usesnode packages/core/engine/cli.mjsbecause its binary is not built locally. - Read
references/cli-commands.mdonly for commands not shown above, source search/replace, inspect, or nonstandard verification depth. - Read
references/local-review.mdwhenever the review gate applies or Workbench controls are needed. - Read
references/render-boundary.mdonly for framework work that changes the Press Tree/runtime contract, not ordinary workspace authoring. - New artifacts are owned by
openpress-create-pagesoropenpress-create-slide; do not use create commands as upgrade tools.