Agency Documentation
********************

This is the documentation for the Agency Project. The **agency-workspace** repository is an umbrella repository for the other repositories:

* **agency-django** — Python package for the Agency Django Project.
* **agency-server** — Compose, Django settings, Celery/ASGI, and example apps (``boe``, ``bopv``, ``chat``).
* **agency-ui** — TypeScript frontend, built and published into agency-django static files.


.. toctree::
   :maxdepth: 3
   :caption: Framework

   quickstart
   concepts
   architecture
   veronica
   display/index
   tutorials/index
   rag
   framework/deployment
   development/index
   changes

.. toctree::
   :maxdepth: 2
   :caption: Reference

   framework/agency/models
   framework/agency/runtime
   framework/agency/tasks
   framework/agency/tools
   framework/agency/miner
   framework/agency/channels
   framework/agency/api
   modindex
   genindex




Stack
-----

* **Django** — HTTP, admin, product SPA at ``/``
* **PostgreSQL** — primary DB
* **Redis** — broker / Channels
* **ChromaDB** — embeddings (reference host)
* **Ollama** — local LLM (reference host)
* **Voice** — STT/TTS at ``/api/voice/`` (optional GPU)
* **Celery** — background tasks
* **Nginx** — reverse proxy + ``/static/``

Gateways: **WSGI** (``agency_django``) and **ASGI** (``agency_asgi``, ``/channel/``).

Product SPA: ``/`` after ``/login/``. Sphinx HTML: ``/static/documentation/``
(``./dev doc html``). One-file HTML: ``./dev doc``
→ ``/static/documentation-single/``. In-container: ``bash run document``.

Author and licence
------------------

Agency is created and maintained by **Txema Vicente Segura**
(``txema@nabla.net``) at **Nabla Soluciones Lógicas, S.L.**

Proprietary — all rights reserved. Each repository carries the terms in its own
``LICENSE`` file.

See also
--------

* :doc:`concepts` — short glossary
* :doc:`architecture` — product vs host vs umbrella
* :doc:`tutorials/index` — first agent, mission, HITL
* :doc:`changes` — shipped work log (newest first)
* `Django Admin Doc`_ — models / views / tags in admin
* Package narrative — sibling ``agency-django/README.md``
* Workspace backlog — ``agency-workspace/todo/README.md``

.. _Django Admin Doc: /admin/doc/