Update docs based on reset refactor

CHANGELOG.md

@@ -6,6 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+- Made environment reset completely recreate the game object.
 - Changed the red agent in the data manipulation scenario to randomly choose client 1 or client 2 to start its attack.
 - Changed the data manipulation scenario to include a second green agent on client 1.
 - Refactored actions and observations to be configurable via object name, instead of UUID.

docs/index.rst

@@ -108,6 +108,7 @@ Head over to the :ref:`getting-started` page to install and setup PrimAITE!
    source/simulation
    source/game_layer
    source/config
+   source/environment
 
 .. toctree::
    :caption: Developer information:

docs/source/environment.rst

@@ -0,0 +1,10 @@
+RL Environments
+***************
+
+RL environments are the objects that directly interface with RL libraries such as Stable-Baselines3 and Ray RLLib. The PrimAITE simulation is exposed via three different environment APIs:
+
+* Gymnasium API - this is the standard interface that works with many RL libraries like SB3, Ray, Tianshou, etc.  ``PrimaiteGymEnv`` adheres to the `Official Gymnasium documentation <https://gymnasium.farama.org/api/env/>`_.
+* Ray Single agent API - For training a single Ray RLLib agent
+* Ray MARL API - For training multi-agent systems with Ray RLLib. ``PrimaiteRayMARLEnv`` adheres to the `Official Ray documentation <https://docs.ray.io/en/latest/rllib/package_ref/env/multi_agent_env.html>`_.
+
+There is a Jupyter notebook which demonstrates integration with each of these three environments. They are located in ``~/primaite/<VERSION>/notebooks/example_notebooks``.

docs/source/game_layer.rst

@@ -20,6 +20,11 @@ The game layer is responsible for managing agents and getting them to interface
 PrimAITE Session
 ^^^^^^^^^^^^^^^
 
+.. admonition:: Deprecated
+   :class: deprecated
+
+   PrimAITE Session is being deprecated in favour of Jupyter Notebooks. The `session` command will be removed in future releases, but example notebooks will be provided to demonstrate the same functionality.
+
 ``PrimaiteSession`` is the main entry point into Primaite and it allows the simultaneous coordination of a simulation and agents that interact with it. ``PrimaiteSession`` keeps track of multiple agents of different types.
 
 Agents

docs/source/primaite_session.rst

@@ -4,6 +4,11 @@
 
 .. _run a primaite session:
 
+.. admonition:: Deprecated
+   :class: deprecated
+
+   PrimAITE Session is being deprecated in favour of Jupyter Notebooks. The ``session`` command will be removed in future releases, but example notebooks will be provided to demonstrate the same functionality.
+
 Run a PrimAITE Session
 ======================