# Underglass documentation

## Guide

Start here if you are using Underglass or writing components for it.

1. [Getting started](https://underglass.dev/docs/guide/getting-started): requirements, install, your first layer, enabling GPU.
2. [Concepts](https://underglass.dev/docs/guide/concepts): the two modes, layers, admission, what the GPU adds over CSS.
3. [Motion](https://underglass.dev/docs/guide/motion): transitions, groups, `Presence`, animation ownership.
4. [Effects](https://underglass.dev/docs/guide/effects): built-in effects and your own WGSL.
5. [Building components](https://underglass.dev/docs/guide/components): the standard for components that work in Underglass.
6. [Troubleshooting](https://underglass.dev/docs/guide/troubleshooting): every fallback reason and its fix.
7. [Other frameworks and plain DOM](https://underglass.dev/docs/guide/frameworks): the core runtime without React, and writing an adapter.

## Reference

- [API reference](https://underglass.dev/docs/reference/api): every export, option and contract.
- [Effects contract](https://underglass.dev/docs/reference/effects): effect validation, time and fallback rules in detail.
- [Worker compositor](https://underglass.dev/docs/reference/worker): the experimental worker path.
- [Distribution](https://underglass.dev/docs/reference/distribution): packing and installing the library.
- [Showcase](https://github.com/RaananW/underglass/blob/main/docs/showcase.md): the example gallery and its deployment.

## Contributing

- [Architecture](https://github.com/RaananW/underglass/blob/main/docs/architecture.md) and the GPU-first contract.
- [Open issues](https://github.com/RaananW/underglass/blob/main/docs/open-issues.md): known limits and unperformed validation.
- [Releasing](https://github.com/RaananW/underglass/blob/main/docs/releasing.md): versions, changesets, the Release workflow and how to enable publishing.
- [Change notes](https://github.com/RaananW/underglass/blob/main/docs/changes/README.md): the notes written before Changesets, kept as history.
- [GPU browser tests in CI](https://github.com/RaananW/underglass/blob/main/docs/ci-gpu-runner.md): the self-hosted GPU runner.
- [3D UI library plan](https://github.com/RaananW/underglass/blob/main/docs/ui-library/plan.md): proposal for a component library with its own 3D design language.
- [Instrument level plan](https://github.com/RaananW/underglass/blob/main/docs/ui-library/instrument.md): proposed 3D-first hardware components (knobs, faders, switches, lamps) as a fourth Strata level.
- [Strata design language](https://underglass.dev/docs/strata/design-language): the spec and [tokens](https://github.com/RaananW/underglass/blob/main/packages/ui/src/tokens/strata.tokens.json) of the 3D UI library.
- [Archive](https://github.com/RaananW/underglass/tree/main/docs/archive/): the phase-by-phase engineering history, measurements and verification records.