From a07ce00852f2803bfcd768755c1bc613eb58e95e Mon Sep 17 00:00:00 2001
From: Marek Wolan <marek.wolan@methods.co.uk>
Date: Tue, 11 Jul 2023 09:56:52 +0100
Subject: [PATCH] Added glossary

---
 docs/index.rst           |  1 +
 docs/source/glossary.rst | 76 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 77 insertions(+)
 create mode 100644 docs/source/glossary.rst

diff --git a/docs/index.rst b/docs/index.rst
index 17dae2c9..4be73154 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -38,6 +38,7 @@ The best place to start is :ref:`about`
    PrimAITE API <source/_autosummary/primaite>
    PrimAITE Tests <source/_autosummary/tests>
    source/dependencies
+   source/glossary
 
 .. toctree::
    :caption: Project Links:
diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst
new file mode 100644
index 00000000..6ebf99f9
--- /dev/null
+++ b/docs/source/glossary.rst
@@ -0,0 +1,76 @@
+Glossary
+=============
+
+.. glossary::
+
+    Network
+        The network in primaite is a logical representation of a computer network containing :term:`Node<Nodes>` and :term:`Link<Links>`.
+
+    Node
+        A Node represents a network endpoint. For example a computer, server, switch, or an actuator.
+
+    Link
+        A Link represents the connection between two Nodes. For example, a physical wire between a computer and a switch or a wireless connection.
+
+    Agent
+        An agent is a representation of a user of the network. Typically this would be a user that is using one of the computer nodes, though it could be an autonomous agent.
+
+    Red Agent
+        An agent that is aiming to attack the network in some way, for example by executing a Denial-Of-Service attack or stealing data.
+
+    Blue Agent
+        A defensive agent that protects the network from Red Agent attacks to minimise disruption to green agents and protect data.
+
+    Green agent
+        Simulates typical benign activity on the network, such as real users using computers and servers.
+
+    Information Exchange Request (IER)
+        ...
+
+    Pattern-of-Life (PoL)
+        ...
+
+    Protocol
+        ...
+
+    Service
+        ...
+
+    Gym
+        ...
+
+    Reward
+        ...
+
+    Access Control List
+        ...
+
+    Observation
+        ...
+
+    Action
+        ...
+
+    StableBaselines3
+        ...
+
+    Ray RLLib
+        ...
+
+    Episode
+        ...
+
+    Step
+        ...
+
+    Reference environment
+        ...
+
+    Transaction
+        ...
+
+    Laydown
+        ...
+
+    User data directory
+        PrimAITE supports upgrading software version while retaining user data. The user data directory is where configs, notebooks, and results are stored, this location is `~/primaite` on linux/darwin and `C:\Users\<username>\primaite` on Windows.