Imported from jiggy/jig (
site/AGENTS.md). Install upstream withnpx skills add jiggy/jig --skill site. Copyright stays with the author.
Public sites
Purpose
Owns the Rspress configuration and static root files for the separate FLOW and Jig public sites.
Ownership
docs/flow/anddocs/jig/own published prose and specifications.flow/andjig/own their site-specific navigation, styles, and public-root files. Each site'sdiagrams.cssfits guide SVGs to the reading column; source diagrams remain with their owning guide underdocs/.- FLOW publishes the Python SDK guide at
/guide/python; navigation andllms.txtlink it, and site assembly checks the route. Jig introduces composition at/guide/request-triage; its navigation, generated index, and assembly gate keep that walkthrough reachable. The bounded factory walkthrough is published at/guide/software-factory. theme/owns the shared default-theme extension;landing.cssowns shared landing and reading presentation. Both deployment triggers include these inputs.package.jsonandbun.lockown shared pinned site tooling;justfileowns the FLOW and Jig Rspress build and development server recipes.
Local Contracts
- Never maintain copied prose or machine schemas here.
- Jig's pricing navigation links to
/pricing, a site page atdocs/jig/pricing.mdthat explains free and paid use in plain language. That page links to the canonicalPRICING.mdandLICENSE.mdas the authoritative terms. - Exclude repository
AGENTS.mdwork contracts from public documentation routes. - Keep origins, navigation, public roots, schemas, contracts, and deployment artifacts separate between FLOW and Jig.
- Apply
docs/AGENTS.md's human-facing identity-URL rule to both sites without replacing machine-resource responses with HTML. Jig contract routes serve Markdown fromdocs/jig/contracts/; sibling<name>/contract.jsondownloads preserve exact invocation bundles, including descriptor-relative channel files. Check both the human pages and machine downloads. scripts/build-site.showns fresh staging, exact artifact copying, inventory enforcement, and cross-site exclusion.- Rspress generates
.mdcompanions,llms.txt, andllms-full.txtfrom the public pages. Do not maintain separate copies of agent-facing prose. - Reconcile navigation, generated indexes, workflow path filters, and build mappings whenever public routes or artifacts change.
- Generated dependency trees, site builds, and deployment artifacts are not source.
Work Guidance
- Change the authoritative document first, then only the navigation or static publication metadata required here.
- Make entrypoints inspiring and task-oriented for developers, agents, and teams. Use Rspress's navigation, search, code rendering, and Markdown export with focused extensions. Judge presentation against excellent product sites, documentation coverage against supported tasks, and simplicity by real paths to useful results; avoid unsupported competitive claims.
- Use Rspress’s native Shiki highlighting with One Dark Pro for dark-mode
code blocks and One Light for light mode on both sites. Shared native color
replacements preserve their hues while improving token contrast.
landing.cssmust apply the emitted dark token variables underhtml.rp-dark; selecting two palettes in configuration alone does not switch their styles. - Keep guide diagrams as static images with the existing image zoom. Preserve ordinary Markdown, theme inheritance, mobile containment, and image aspect ratios; no embedded diagram viewer is needed for the reading path.
Verification
- Build each affected site into a fresh output directory with
scripts/build-site.sh. - Use
scripts/check-site.shonly to check an already deployed endpoint.
Child DOX Index
- theme/AGENTS.md — Shared layout extension without product prose.
