diff --git a/docs/index.rst b/docs/index.rst index a59533c7..9035c87c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,6 +8,46 @@ Welcome to PrimAITE's documentation What is PrimAITE? ----------------- +.. toctree:: + :maxdepth: 8 + :caption: About PrimAITE: + :hidden: + + source/about + source/dependencies + source/glossary + +.. toctree:: + :caption: Usage: + :hidden: + + source/getting_started + source/game_layer + source/simulation + source/config + source/customising_scenarios + source/varying_config_files + source/environment + source/action_masking + +.. toctree:: + :caption: Notebooks: + :hidden: + + source/example_notebooks + source/notebooks/executed_notebooks + +.. toctree:: + :caption: Developer information: + :hidden: + + source/developer_tools + source/state_system + source/request_system + PrimAITE API + PrimAITE Tests + + Overview ^^^^^^^^ diff --git a/docs/source/about.rst b/docs/source/about.rst index 06eff34e..7d53a487 100644 --- a/docs/source/about.rst +++ b/docs/source/about.rst @@ -70,46 +70,6 @@ Getting Started with PrimAITE Head over to the :ref:`getting-started` page to install and setup PrimAITE! -.. toctree:: - :maxdepth: 8 - :caption: About PrimAITE: - :hidden: - - source/about - source/dependencies - source/glossary - -.. toctree:: - :caption: Usage: - :hidden: - - source/getting_started - source/game_layer - source/simulation - source/config - source/customising_scenarios - source/varying_config_files - source/environment - source/action_masking - -.. toctree:: - :caption: Notebooks: - :hidden: - - source/example_notebooks - source/notebooks/executed_notebooks - -.. toctree:: - :caption: Developer information: - :hidden: - - source/developer_tools - source/state_system - source/request_system - PrimAITE API - PrimAITE Tests - - .. Architecture - Nodes and Links ****************************** diff --git a/docs/source/simulation_components/system/applications/dos_bot.rst b/docs/source/simulation_components/system/applications/dos_bot.rst index 2a26a971..9925dc93 100644 --- a/docs/source/simulation_components/system/applications/dos_bot.rst +++ b/docs/source/simulation_components/system/applications/dos_bot.rst @@ -7,7 +7,10 @@ DoSBot ###### -The ``DoSBot`` is an implementation of a Denial of Service attack within the PrimAITE simulation. This specifically simulates a `Slow Loris attack `. +The ``DoSBot`` is an implementation of a Denial of Service attack within the PrimAITE simulation. +This specifically simulates a `Slow Loris attack`_. + +.. _Slow Loris Attack: https://en.wikipedia.org/wiki/Slowloris_(computer_security) Key features ============ diff --git a/docs/source/simulation_components/system/applications/nmap.rst b/docs/source/simulation_components/system/applications/nmap.rst index abfa439d..1e7f5ea4 100644 --- a/docs/source/simulation_components/system/applications/nmap.rst +++ b/docs/source/simulation_components/system/applications/nmap.rst @@ -5,10 +5,10 @@ .. _NMAP: NMAP -==== +#### Overview --------- +======== The NMAP application is used to simulate network scanning activities. NMAP is a powerful tool that helps in discovering hosts and services on a network. It provides functionalities such as ping scans to discover active hosts and port scans @@ -19,8 +19,8 @@ structure, identify active devices, and find potential vulnerabilities by discov However, it is also a tool frequently used by attackers during the reconnaissance stage of a cyber attack to gather information about the target network. -Scan Types ----------- +Scan Type +========= Ping Scan ^^^^^^^^^ @@ -46,7 +46,7 @@ identifying potential entry points for attacks. There are three types of port sc It gives a comprehensive view of the network's service landscape. Example Usage -------------- +^^^^^^^^^^^^^ The network we use for these examples is defined below: diff --git a/docs/source/simulation_components/system/applications/web_browser.rst b/docs/source/simulation_components/system/applications/web_browser.rst index 162463a0..dbe2da28 100644 --- a/docs/source/simulation_components/system/applications/web_browser.rst +++ b/docs/source/simulation_components/system/applications/web_browser.rst @@ -23,7 +23,7 @@ Usage ===== - Install on a Node via the ``SoftwareManager`` to start the ``WebBrowser``. -- Service runs on HTTP port 80 by default. (TODO: HTTPS) +- Service runs on HTTP port 80 by default. - Execute sending an HTTP GET request with ``get_webpage`` Implementation