#2837 - Minor structure reshuffle to address confusion around the listen_on_ports variable [skip ci]

docs/source/simulation_components/system/common/common_configuration.rst

@@ -2,35 +2,38 @@
 
     © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 
-``ref``
-=======
+.. _Common Configuration:
 
-Human readable name used as reference for the |SOFTWARE_NAME_BACKTICK|. Not used in code.
+Common Configuration
+--------------------
 
-``type``
-========
+ref
+"""
 
-The type of software that should be added. To add |SOFTWARE_NAME| this must be |SOFTWARE_NAME_BACKTICK|.
+Human readable name used as reference for the software class. Not used in code.
 
-``options``
-===========
+type
+""""
+
+The type of software that should be added. To add the required software, this must be it's name.
+
+options
+"""""""
 
 The configuration options are the attributes that fall under the options for an application.
 
-
-
-``fix_duration``
-""""""""""""""""
+fix_duration
+""""""""""""
 
 Optional. Default value is ``2``.
 
-The number of timesteps the |SOFTWARE_NAME| will remain in a ``FIXING`` state before going into a ``GOOD`` state.
+The number of timesteps the software will remain in a ``FIXING`` state before going into a ``GOOD`` state.
 
 
-``listen_on_ports``
-"""""""""""""""""""
+listen_on_ports
+^^^^^^^^^^^^^^^
 
-The set of ports to listen on. This is in addition to the main port the software is designated. This can either be
+Optional. The set of ports to listen on. This is in addition to the main port the software is designated. This can either be
 the string name of ports or the port integers
 
 Example:
@@ -40,11 +43,8 @@ Example:
     simulation:
       network:
         nodes:
-        - hostname: client
-          type: computer
-          ip_address: 192.168.10.11
-          subnet_mask: 255.255.255.0
-          default_gateway: 192.168.10.1
+        - hostname: [hostname]
+          type: [Node Type]
           services:
             - type: [Service Type]
               options: