From c3010ff816882e47809bd4889b2b9c15253c2ce9 Mon Sep 17 00:00:00 2001
From: Marek Wolan <marek.wolan@methods.co.uk>
Date: Mon, 4 Mar 2024 18:59:03 +0000
Subject: [PATCH] Update changelog and docs

---
 CHANGELOG.md                              | 1 +
 docs/source/configuration/io_settings.rst | 7 +++++++
 2 files changed, 8 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index d54af980..48998d57 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -29,6 +29,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fixed the order of service health state
 - Fixed an issue where starting a node didn't start the services on it
 - Added support for SQL INSERT command.
+- Added ability to log each agent's action choices each step to a JSON file.
 
 
 
diff --git a/docs/source/configuration/io_settings.rst b/docs/source/configuration/io_settings.rst
index 96cc28fe..e5c6d2ce 100644
--- a/docs/source/configuration/io_settings.rst
+++ b/docs/source/configuration/io_settings.rst
@@ -19,6 +19,7 @@ This section configures how PrimAITE saves data during simulation and training.
         # save_logs: True
         # save_transactions: False
         # save_tensorboard_logs: False
+        save_agent_actions: True
         save_step_metadata: False
         save_pcap_logs: False
         save_sys_logs: False
@@ -65,6 +66,12 @@ Defines how often to save the policy during training.
 
 *currently unused*.
 
+``save_agent_actions``
+
+Optional. Default value is ``True``.
+
+If ``True``, this will create a JSON file each episode detailing every agent's action each step in that episode, formatted according to the CAOS format. This includes scripted, RL, and red agents.
+
 ``save_step_metadata``
 ----------------------