# Nous AI Documentation

Documentation hub for the Nous AI framework. For the full, searchable API
reference, see **[hexdocs.pm/nous](https://hexdocs.pm/nous)**.

## 🚀 Quick Start
- **[Getting Started](getting-started.md)** — setup and first steps.
- **[Hello World](../examples/01_hello_world.exs)** — minimal example to verify your install.

## 📖 Guides
All guides live in **[guides/](guides/README.md)** — a categorized index covering
core features, orchestration & multi-agent, providers & backends, and operations.
Highlights:

- **[Tool Development](guides/tool_development.md)** · **[Structured Output](guides/structured_output.md)** · **[Skills](guides/skills.md)** · **[Hooks](guides/hooks.md)**
- **[Memory](guides/memory.md)** · **[Knowledge Base](guides/knowledge_base.md)** · **[Evaluation](guides/evaluation.md)**
- **[Teams](guides/teams.md)** · **[Decisions](guides/decisions.md)** · **[Deep Research](guides/research.md)** · **[Workflows](guides/workflows.md)**
- **[Providers Overview](guides/providers.md)** · **[Fallback](guides/fallback.md)** · **[HTTP Backends](guides/http_backends.md)**
- **[Permissions & Guardrails](guides/permissions.md)** · **[Observability](guides/observability.md)**
- **[LiveView Integration](guides/liveview-integration.md)** · **[Best Practices](guides/best_practices.md)** · **[Troubleshooting](guides/troubleshooting.md)** · **[Migration](guides/migration_guide.md)**

## 📚 Examples
- **[Examples directory](../examples/README.md)** — the numbered walkthroughs plus
  `providers/`, `memory/`, `advanced/`, `workflow/`, and `eval/`.

## 🔧 Architecture & Design
- **[LLM Council Design](design/llm_council_design.md)** — architecture decisions and patterns.
- **[Benchmarks](benchmarks/http_backend.md)** — performance notes (e.g. HTTP backends).

---

## Where to start

- **New users** → [Getting Started](getting-started.md), then the [numbered examples](../examples/README.md), then a focused [guide](guides/README.md).
- **Building tools** → [Tool Development](guides/tool_development.md).
- **Production deployment** → [Best Practices](guides/best_practices.md) + [Permissions & Guardrails](guides/permissions.md) + [Observability](guides/observability.md).
- **API reference** → [hexdocs.pm/nous](https://hexdocs.pm/nous).

---

## External Resources
- **GitHub**: https://github.com/nyo16/nous
- **Hex Package**: https://hex.pm/packages/nous
- **API Docs**: https://hexdocs.pm/nous
- **Community**: GitHub Discussions and Issues