.. _architecture_decisions:

=============================
Architecture Decision Records
=============================

The following documents the architecture decision records (ADRs) when developing
this project. ADRs are a way to capture architectural decisions made during the
development of a software project. More details can be found in the
:ref:`architecture_decisions_references` section.

.. toctree::
   :maxdepth: 1

   01_file_structure
   02_inter_thread_comm

A template for ADR is provided at ``templates/decisions.tmpl`` for adding new
ADRs.

.. _architecture_decisions_references:

References
----------

* Blog: `ADR: Deep Dive into Architecture Decision Records
  <https://okorkmaz.medium.com/adr-deep-dive-into-architecture-decision-records-8c110ce7d74e>`_
* GitHib: `joelparkerhenderson/architecture-decision-record
  <https://github.com/joelparkerhenderson/architecture-decision-record>`_
* Template: `Template by Jeff Tyree and Art Akerman
  <https://github.com/joelparkerhenderson/architecture-decision-record/tree/main/locales/en/templates/decision-record-template-by-jeff-tyree-and-art-akerman>`_
* Examples: `Examples
  <https://github.com/joelparkerhenderson/architecture-decision-record/tree/main/locales/en/examples>`_