# Synclair

> One aligned source of truth — design tokens, components, and knowledge — for humans and AI agents building the same product.

## Docs

- [Skills & agents](https://docs.synclair.dev/agents-and-skills.md): How Synclair packages know-how as skills, does heavy reading with digger agents, and — the key part — how the two work together.
- [Keeping the catalog in sync](https://docs.synclair.dev/catalog-sync.md): In existing-project mode the hub documents your real components — here are the two ways to keep that catalog current as the host code changes: run the cataloger yourself, or let the catalog-gate CI do it on every PR.
- [Component library](https://docs.synclair.dev/component-library.md): The catalog of what the product's UI is made of — three tiers, live previews, and a doc page for every item.
- [Customizing & modifying Synclair](https://docs.synclair.dev/customizing.md): Yes — you can change any of it. The three-layer model tells you what's yours, what's swappable, and what syncs from upstream.
- [Environment](https://docs.synclair.dev/environment.md): The running stack, and the opt-in freshness check for whether your clone is behind the upstream Synclair foundation.
- [FAQ](https://docs.synclair.dev/faq.md): The fast answers to the questions everyone asks first.
- [Foundations](https://docs.synclair.dev/foundations.md): The design tokens — color, type, and spacing as one semantic vocabulary that both people and machine checks hold the UI to.
- [GitHub](https://docs.synclair.dev/github.md): Recent repo activity, surfaced right in the hub — because git isn't just where the code lives, it's the hub's database.
- [How it works](https://docs.synclair.dev/how-it-works.md): The non-obvious parts — where the database is, and how Synclair rides on git and the AI tools you already use.
- [Hygiene](https://docs.synclair.dev/hygiene.md): Where the host app's code steps outside its own foundation — inline styles, raw colors, bypassed primitives — surfaced as an advisory sweep.
- [What is Synclair?](https://docs.synclair.dev/index.md): One aligned source of truth — design tokens, components, and knowledge — that humans and AI agents read the same way.
- [Installation](https://docs.synclair.dev/installation.md): Two ways to install, by topology: embed Synclair in the product repo, or watch it from a separate one. Either works whether the repo is new or already exists.
- [Knowledge](https://docs.synclair.dev/knowledge.md): The section that keeps agents from starting blank — source-of-truth links, distilled digests, and generated summaries, all in one place.
- [References](https://docs.synclair.dev/references.md): The project's growing library of findings — prior art, research, and recommendations that agents accumulate as they work.
- [Reports](https://docs.synclair.dev/reports.md): A plain-English read of how the build is doing and what to do next — one block per section, plus a ranked, trackable to-do list.
- [Search (⌘K)](https://docs.synclair.dev/search.md): One command palette across the whole hub — components, blocks, templates, tokens, docs, and pages, all one keystroke away.
- [Setup modes](https://docs.synclair.dev/setup-modes.md): Embedded vs. watcher — the two ways a Synclair clone can sit relative to your product, and what each one costs and buys.
- [App sitemap](https://docs.synclair.dev/sitemap.md): Every view the app serves — the route tree, a live preview of each screen, how they connect, and the components each one composes.
- [Library & surfaces](https://docs.synclair.dev/surfaces.md): For products with more than one frontend — a per-surface drill-in so a web app and a native app share one hub without colliding.
- [System map](https://docs.synclair.dev/system-map.md): What the codebase is made of beyond the UI — areas, the API surface, the data model, jobs, and integrations — so anyone can orient without reading source.
- [Overview](https://docs.synclair.dev/the-hub.md): A map of every section of the Synclair hub, each linking to its own deep dive.
- [Synclair vs. Storybook](https://docs.synclair.dev/vs-storybook.md): They both show components in a gallery. That's where the resemblance ends.