Core User Guide Feeedback Implemented.

Feedback Issues left:

1.Issues with red-agent image not embeded correctly in data_manipulation_e2e notebook

2._autosummary/tests.unit_tests.html is still completely blank.

3. _index.html is not updated with new 2-pager

4. _dependencies is not updated to just include tier-1 and primary for v3.

5. definiton of user_app_home is not confirmed

src/primaite/notebooks/Data-Manipulation-E2E-Demonstration.ipynb

@@ -180,15 +180,15 @@
     "| link_id | endpoint_a       | endpoint_b        |\n",
     "|---------|------------------|-------------------|\n",
     "| 1       | router_1         | switch_1          |\n",
-    "| 1       | router_1         | switch_2          |\n",
-    "| 1       | switch_1         | domain_controller |\n",
-    "| 1       | switch_1         | web_server        |\n",
-    "| 1       | switch_1         | database_server   |\n",
-    "| 1       | switch_1         | backup_server     |\n",
-    "| 1       | switch_1         | security_suite    |\n",
-    "| 1       | switch_2         | client_1          |\n",
-    "| 1       | switch_2         | client_2          |\n",
-    "| 1       | switch_2         | security_suite    |\n",
+    "| 2       | router_1         | switch_2          |\n",
+    "| 3       | switch_1         | domain_controller |\n",
+    "| 4       | switch_1         | web_server        |\n",
+    "| 5       | switch_1         | database_server   |\n",
+    "| 6       | switch_1         | backup_server     |\n",
+    "| 7       | switch_1         | security_suite    |\n",
+    "| 8       | switch_2         | client_1          |\n",
+    "| 9       | switch_2         | client_2          |\n",
+    "| 10      | switch_2         | security_suite    |\n",
     "\n",
     "\n",
     "The ACL rules in the observation space appear in the same order that they do in the actual ACL. Though, only the first 10 rules are shown, there are default rules lower down that cannot be changed by the agent. The extra rules just allow the network to function normally, by allowing pings, ARP traffic, etc.\n",
@@ -705,7 +705,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.11"
+   "version": "3.10.8"
   }
  },
  "nbformat": 4,

src/primaite/notebooks/Using-Episode-Schedules.ipynb

@@ -13,50 +13,6 @@
     "directory with several config files that work together."
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Defining variations in the config file.\n",
-    "\n",
-    "### Base scenario\n",
-    "The base scenario is essentially the same as a fixed YAML configuration, but it can contain placeholders that are \n",
-    "populated with episode-specific data at runtime. The base scenario contains any network, agent, or settings that\n",
-    "remain fixed for the entire training/evaluation session.\n",
-    "\n",
-    "The placeholders are defined as YAML Aliases and they are denoted by an asterisk (`*placeholder`).\n",
-    "\n",
-    "### Variations\n",
-    "For each variation that could be used in a placeholder, there is a separate yaml file that contains the data that should populate the placeholder.\n",
-    "\n",
-    "The data that fills the placeholder is defined as a YAML Anchor in a separate file, denoted by an ampersand (`&anchor`).\n",
-    "\n",
-    "[Learn more about YAML Aliases and Anchors here.](https://www.educative.io/blog/advanced-yaml-syntax-cheatsheet#:~:text=YAML%20Anchors%20and%20Alias)\n",
-    "\n",
-    "### Schedule\n",
-    "Users must define which combination of scenario variations should be loaded in each episode. This takes the form of a\n",
-    "YAML file with a relative path to the base scenario and a list of paths to be loaded in during each episode.\n",
-    "\n",
-    "It takes the following format:\n",
-    "\n"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "```yaml\n",
-    "base_scenario: base.yaml\n",
-    "schedule:\n",
-    "  0: # list of variations to load in at episode 0 (before the first call to env.reset() happens)\n",
-    "    - laydown_1.yaml\n",
-    "    - attack_1.yaml\n",
-    "  1: # list of variations to load in at episode 1 (after the first env.reset() call)\n",
-    "    - laydown_2.yaml\n",
-    "    - attack_2.yaml\n",
-    "```\n"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {},

src/primaite/notebooks/multi-processing.ipynb

@@ -4,8 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Simple multi-processing demo using SubprocVecEnv from SB3\n",
-    "Based on a code example provided by Rachael Proctor."
+    "## Simple multi-processing demo using SubprocVecEnv from SB3"
    ]
   },
   {