# Documentation

This directory contains guides for building bots with the metatell Bot SDK.

## Guides

- [Getting started](./getting-started.md): install the SDK, connect to a room, and run a minimal bot.
- [API overview](./api.md): high-level and low-level SDK APIs.
- [Examples](./examples.md): practical bot patterns and runnable examples.
- [Logging and errors](./logging-and-errors.md): error handling, logging, and diagnostics.
- [Troubleshooting](./troubleshooting.md): common setup and runtime issues.
- [FAQ](./faq.md): short answers to common questions.
- [NAF messages](./NAF.md): typed helpers for networked avatar synchronization messages.
- [Release process](./RELEASE.md): repository release workflow.

## Public API Reference

The generated TypeDoc site is published at:

https://sdk.metatell.io/bot/

Use the generated reference for exact method signatures and exported types. Use
the guides in this directory for setup, workflow examples, and operational notes.