mirror of
https://github.com/paperclipai/paperclip-docs.git
synced 2026-11-07 06:16:07 -10:00
Aron PrinsandClaude Opus 4.8
5f00622542
Builds an end-to-end pipeline that keeps docs screenshots in sync with the
latest Paperclip build, replacing the previously-manual capture step.
scripts/screenshots/:
- config.mjs isolated-instance env helpers (local_trusted/loopback,
scratch PAPERCLIP_HOME, never touches ~/.paperclip)
- seed.mjs idempotent demo-data seeding via REST (company/agents/
project/goal/issues/routine/workspace); writes .seed-ids.json
- routes.mjs 56 CAPTURE_TARGETS with real ui/src depends_on paths;
resolveRoute() uses the server-derived issuePrefix
- capture.mjs Playwright capture (light+dark, 1440x900 @2x), theme seeded
to match ui/index.html, stamps registry captured_sha
- sync-registry.mjs back-fills route + depends_on into registry.json
- run.mjs one-command orchestrator: onboard -> health -> seed ->
sync-registry -> capture -> teardown
- README.md prerequisites, flow, overhaul mode, safety notes
Wiring:
- package.json: screenshots:{seed,capture,sync-registry,refresh,refresh:all}
+ @playwright/test devDependency
- screenshots:refresh:all is the full re-take mode for major UI/UX overhauls
- sync-docs SKILL.md Phase 6: capture is now automatable (still PR-reviewed,
never auto-pushed); maintenance.md updated to match
- .gitignore: scripts/screenshots/.seed-ids.json
Auth is free in local_trusted mode (every request is admin), so no login flow
is needed. Capture/staleness still surface to a PR for human review.
Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
skills/
Claude Code skills that ship with this repo. These are committed alongside the docs so the sync workflow stays reproducible across machines and contributors.
Available skills
| Skill | What it does | Invoke |
|---|---|---|
sync-docs |
Keeps these docs in lockstep with the parent paperclipai/paperclip codebase. Two modes: nightly (tracks parent main, preview deploy) and release (on parent tag, merges to main, ships live). |
/sync-docs |
Using a skill from this repo
Skills here are plain Markdown files with frontmatter. Claude Code discovers them by directory.
Option A — symlink into your user-level skills dir
mkdir -p ~/.claude/skills
ln -s "$PWD/skills/sync-docs" ~/.claude/skills/sync-docs
The /sync-docs slash command becomes available in any session.
Option B — project-level skills dir
If your Claude Code setup supports per-project skills (.claude/skills/), link from there:
mkdir -p .claude/skills
ln -s "../../skills/sync-docs" .claude/skills/sync-docs
Either way, the skill files themselves stay versioned in skills/, so updates flow with normal git operations.
Why skills live in the repo
The doc-sync workflow is repo-specific (it knows about our anchor-map.json, our branch model, our voice rules). Shipping it inside the repo means:
- Anyone cloning the repo gets the workflow.
- Changes to the workflow review like any other PR.
- The skill's prompts evolve alongside the docs they produce.