Synapse UI Documentation
Welcome to the Synapse UI documentation. This folder contains the source markdown for guides, architecture references, component APIs, and Architecture Decision Records (ADRs).
Quick Links
| Section | Description |
|---|---|
| Guides | Install, configure, and ship with Synapse UI |
| Architecture | System design and monorepo layout |
| Theming | Design tokens and ThemeService |
| Components | Component API reference |
| ADRs | Recorded architectural decisions |
Documentation Sites
| Platform | Purpose | Command |
|---|---|---|
Docusaurus (apps/docs) | Public docs site with search and navigation | nx run docs:serve |
| Storybook | Interactive component playground | nx run ui-components:storybook |
The markdown in this folder is the canonical source. Docusaurus will ingest these files during Phase 3 setup (see PROGRESS.md).
Conventions
- File names use kebab-case.
- Component docs follow a consistent template: Overview → API → Examples → Accessibility → Theming.
- ADRs are numbered sequentially and never deleted — superseded ADRs are marked as such.