# Straumr Documentation

This directory documents Straumr from three angles:

- How to use it as an end user.
- How it stores and resolves data on disk.
- How the codebase is structured and released.

## Guide Map

- [User Workflows](./user-workflows.md): setup, workspace lifecycle, requests, auth, secrets, and request sending.
- [Command Reference](./command-reference.md): command groups, aliases, notable flags, and exit-code behavior.
- [AI Agent Guide](./agents-doc.md): machine-readable usage patterns, filtering, JSON envelopes, and automation-safe workflows.
- [Themes](./themes.md): theme installation, `theme.json` format, truecolor behavior, and ANSI color names.
- [Data Model](./data-model.md): file layout, JSON shapes, serialization details, and resolution rules.
- [Architecture](./architecture.md): solution structure, service responsibilities, and runtime flow through the app.
- [Development](./development.md): local build assumptions, code organization, and release pipeline details.

## Reading Order

If you are new to Straumr, read:

1. [User Workflows](./user-workflows.md)
2. [Command Reference](./command-reference.md)
3. [Data Model](./data-model.md)

If you are changing the codebase, read:

1. [Architecture](./architecture.md)
2. [Data Model](./data-model.md)
3. [Development](./development.md)