Docs

Set up Pagewell in three steps.

Install the skill, let Pagewell inspect your repo, and create PAGEWELL.md — the single source of truth your agent needs before generating any page.

$ bunx skills add ReScienceLab/pagewell --skill pagewell

Installs the Pagewell agent skill via skills.sh.

View generated product page

Step 01

Install

Add Pagewell through skills.sh so the router and packaged references are available to your coding agent.

Step 02

Discover

Let discover-site inspect repo files, legacy product facts, routes, components, metadata, and page patterns.

Step 03

Generate

Future runs read PAGEWELL.md and DESIGN.md before selecting a page playbook and adapter.

Quickstart

Run the installer, then ask Pagewell to discover the repo.

terminal

bunx skills add ReScienceLab/pagewell --skill pagewell
# Pi users:
bunx skills add ReScienceLab/pagewell --skill pagewell -a pi

# Then ask your agent:
Use Pagewell to discover this repo and create PAGEWELL.md.

Context file

PAGEWELL.md is the Pagewell memory for the repo.

The discover-site skill should consolidate product facts, supported and prohibited claims, site implementation details, route taxonomy, page/component patterns, generation rules, anti-generic QA rules, and QA rules.

Capture framework, routing, metadata, component, and deployment conventions in the site implementation section.
Import products.yaml or other product data into product facts and supported claims.
Inventory reusable page patterns from existing routes and components.
Mark uncertain facts as unknown instead of letting future generation invent them.

Required context

Generation now has two durable inputs before the brief.

File	Purpose	Why it's separate
DESIGN.md	Visual identity contract	External spec and linter
PAGEWELL.md	Product, site, patterns, claims, and QA truth	Pagewell-specific repo context
Page brief	Route, intent, audience, CTA, and constraints	Varies by request

Verification

Confirm the package and site before trusting generation.

checks

bun run build:skill
bun run check:skill
bun run lint:design
bun run build:site
bun run check:site

FAQ

Common questions, answered directly.

What does PAGEWELL.md contain?

PAGEWELL.md is the default Pagewell context file. It contains product truth, site implementation details, route patterns, supported claims, generation rules, and QA expectations for future runs.

Why keep DESIGN.md separate?

DESIGN.md follows an external Google Labs Code spec and can be linted independently. PAGEWELL.md references it instead of duplicating the design token contract.

What happens on the first Pagewell run?

The router checks for PAGEWELL.md and DESIGN.md. If PAGEWELL.md is missing, it routes to discover-site to inspect the repo and create the unified context file.

Set up Pagewell

Ready to set up your repo context?

Install Pagewell and run discover-site to create PAGEWELL.md so every future page uses real product facts.