# Documentation

This directory contains all `@gravity-ui/aikit` documentation.

## For Consumers

Start here if you're integrating AIKit into your application.

- [**GETTING_STARTED.md**](./GETTING_STARTED.md) — install, render `ChatContainer`, customize via organisms
- [**COMPONENTS.md**](./COMPONENTS.md) — catalog of all 49 components with one-line descriptions
- [**HOOKS.md**](./HOOKS.md) — public hooks reference
- [**THEMING.md**](./THEMING.md) — CSS variables, light/dark themes
- [**I18N.md**](./I18N.md) — per-component localization (en, ru)
- [**EXAMPLES.md**](./EXAMPLES.md) — streaming, file upload, custom message types, OpenAI integration
- [**TROUBLESHOOTING.md**](./TROUBLESHOOTING.md) — peer-deps, theming, markdown rendering FAQs
- [**AI_AGENTS.md**](./AI_AGENTS.md) — configure Claude Code / Cursor in your project to use AIKit correctly

## Deep Dives

- [**ARCHITECTURE.md**](./ARCHITECTURE.md) — Atomic Design layers, two-level approach, type system, extensibility
- [**PROJECT_STRUCTURE.md**](./PROJECT_STRUCTURE.md) — source tree overview

## For Contributors

- [**TESTING.md**](./TESTING.md) — Playwright Component Testing setup
- [**PLAYWRIGHT.md**](./PLAYWRIGHT.md) — quick reference for Playwright commands
- [**guidelines/**](./guidelines/) — internal conventions for components, stories, tests, READMEs, and code style

## Quick Links

- [Main README](../README.md)
- [Live Storybook](https://preview.gravity-ui.com/aikit/)
- [Contributing](../CONTRIBUTING.md)
- [License](../LICENSE)
- [`llms.txt`](../llms.txt) / [`llms-full.txt`](../llms-full.txt) — machine-readable index for LLM agents
