This repo is the Permix monorepo (library v4, docs site, examples). Most agents here are maintainers working on the package, docs, or examples.
Skills for teams using Permix ship in the published npm package at permix/skills/. Repo-root skills/permix is a symlink alias (same pattern as redux-toolkit/skills) so CI and GitHub resolve skills from the monorepo root. Consumers install via TanStack Intent (pnpm dlx @tanstack/intent@latest install) or copy from node_modules/permix/skills/.
Repo-root _artifacts/ (domain_map.yaml, skill_spec.md, skill_tree.yaml) tracks skill coverage and source-doc references for CI staleness checks.
When you change public API behavior, docs examples, or integration patterns, keep permix/skills/ aligned with docs/content/docs/ and examples/, bump library_version in SKILL frontmatter on release, and run cd permix && pnpm run skills:stale.
| Path | Purpose |
|---|---|
permix/ |
Published npm package (permix); build inside this folder |
permix/src/core/ |
Core API (createPermix, setup, check, template, merge, events) |
permix/src/<framework>/ |
Adapters (react, vue, express, trpc, next, …) |
docs/ |
Documentation site (Fumadocs + TanStack Start) |
docs/content/docs/ |
MDX documentation pages |
docs/src/routes/ |
App routes; homepage code samples in docs/src/routes/-code/ |
examples/ |
Runnable sample apps — reference when validating integrations |
permix/skills/ |
Agent skills shipped in the npm package (TanStack Intent) |
skills/permix |
Symlink → permix/skills/ for monorepo-root discovery and CI |
_artifacts/ |
Intent domain map, skill spec, and skill tree for CI staleness |
Docs site: https://permix.letstri.dev — machine-readable exports: /llms.txt and /llms-full.txt on the docs app.
From repo root (pnpm workspace: permix, docs, examples/*):
pnpm install
pnpm test && pnpm run check-types
pnpm run lint
cd permix && pnpm run build
cd docs && pnpm dev # http://localhost:3000
cd docs && pnpm types:check # fumadocs-mdx + tsc for docs onlyDo not commit unless the user asks.