# @k8o/arte-odyssey

> k8o's React UI library (React 19, TypeScript, Tailwind CSS 4) with semantic design
> tokens, dark mode, and official generative UI adapters (json-render & OpenUI) that let
> an LLM generate, validate, and render on-brand UIs from these components.

When installed via npm, these docs live under `node_modules/@k8o/arte-odyssey/docs/`.
Start with GUIDE.md, then follow the reference most relevant to the task.

## Guide

- [Design Guide](GUIDE.md): setup, design direction, aesthetic guidelines, component usage principles, anti-patterns, implementation principles.

## References

- [Components](references/components.md): full component list, import paths, props.
- [Generative UI](references/generative-ui.md): use json-render / OpenUI to make an LLM generate UIs — `catalog.prompt()` (server-safe), `<JsonRenderUI spec={spec} />` (client), `validateGeneratedSpec()` (validate/repair LLM output), `satisfies ArteSpec` (typed specs), and `@k8o/arte-odyssey/openui/prompt`.
- [Typography](references/typography.md): type scale and usage.
- [Color](references/color.md): semantic token system and dark mode.
- [Spacing & layout](references/spatial-design.md): spacing scale and layout patterns.
- [Interaction](references/interaction-design.md): motion and interaction guidelines.
- [Hooks](references/hooks.md): custom hooks.
- [Helpers & types](references/helpers.md): helper functions and types.