#403 remaining documentation

pocket/ui/apps/guide.lua

@@ -189,7 +189,7 @@ local function new_view(root)
         load_text(false, "Connecting Devices")
         local conn_dev_page = guide_section(sect_construct_data, use_page, "Connecting Devs", docs.usage.conn, 110)
         load_text(false, "Configuring Devices")
-        local config_dev_page = guide_section(sect_construct_data, use_page, "Configuring Devs", docs.usage.config, 200)
+        local config_dev_page = guide_section(sect_construct_data, use_page, "Configuring Devs", docs.usage.config, 350)
         load_text(false, "Manual Control")
         local man_ctrl_page = guide_section(sect_construct_data, use_page, "Manual Control", docs.usage.manual, 100)
         load_text(false, "Auto Control")

pocket/ui/docs.lua

@@ -103,11 +103,10 @@ sect("Overview")
 tip("For the best setup experience, see the Wiki on GitHub or the YouTube channel! This app does not contain all information.")
 text("All devices have a configurator program you can launch by running the 'configure' command.")
 sect("Networking")
-text("TBD")
+doc("usage_cfg_chan", "Channels", "Channels are used for the computer to computer communication, described in the connection guide section. Channels with the same name must have the same value across all devices in your system and channels with different names cannot overlap.")
-doc("usage_cfg_chan", "Channels", "TBD")
+doc("usage_cfg_to", "Conn Timeout", "After this period of time the device will close the connection assuming the other device is unresponsive.")
-doc("usage_cfg_to", "Conn Timeout", "TBD")
+doc("usage_cfg_tr", "Trusted Range", "Devices further than this block distance away will have any network traffic rejected by this device.")
-doc("usage_cfg_tr", "Trusted Range", "TBD")
+doc("usage_cfg_auth", "Authentication", "To provide a level of security, you can enable facility-wide authentication by setting keys, which must be the same (and set) on all your devices. This adds computation time to each network transmission so you should only do this if you need it on multiplayer.")
-doc("usage_cfg_auth", "Authentication", "TBD")
 sect("Logging")
 text("Logs are automatically saved to a log.txt file in the root of the computer. You can change the path to it, if it contains verbose debug messages, and if it is appended to or overwritten each time the program runs.")
 text("If you intend to be able to share logs, you should leave it to append.")
@@ -121,13 +120,24 @@ sect("RTU Gateway")
 text("The RTU Gateway allows connecting multiple RTU interfaces to the SCADA system. These interfaces may be external peripherals or redstone.")
 text("All devices except for fission reactors must be connected via an RTU Gateway.")
 sect("Supervisor")
-text("TBD")
+text("The Supervisor configuration is core to the entire system. If you change things about the system, such as the cooling devices or reactor count, it must be updated here.")
+text("This configuration contains many settings that are detailed better in the configurator so they will not be covered here.")
+doc("usage_cfg_sv_tanks", "Dynamic Tanks", "Dynamic tanks can be used to provide emergency coolant (and/or auxiliary coolant) to the system. Many layouts are supported by using a mix of facility tanks (connect to 1+ units) and unit tanks (connect to only one unit).")
+doc("usage_cfg_sv_aux", "Auxiliary Coolant", "This coolant is enabled at the start of reactors to prevent water levels from dropping in the reactor or boiler while the turbine ramps up. This can be connected to a dynamic tank, a sink, or any other water supply.")
 sect("Coordinator")
-text("TBD")
+text("The Coordinator configuration is mainly focused around setting up your displays. This is best to do last after everything else. See the wiki on the GitHub for details on monitor sizing.")
+tip("When changing the unit count on the Supervisor, you must also update it on the Coordinator.")
+doc("usage_cfg_crd_main", "Main Monitor", "The main monitor contains the main interface and overview. It is always 8 block wide with varying height depending on how many units you have.")
+doc("usage_cfg_crd_flow", "Flow Monitor", "The flow monitor contains the waste and coolant flow diagram. It is always 8 block wide with varying height depending on how many units you have.")
+doc("usage_cfg_crd_unit", "Unit Monitor", "You need one unit monitor per reactor, and it is always a 4x4 monitor.")
+text("Monitors can be connected by direct contact or via wired modems.")
+text("Various unit and color options are available to customize the display to your liking. Using energy scales other than RF can impact the precision of your power-related auto control setpoints as RF is always used internally.")
 sect("Pocket")
-text("TBD")
+text("You're already here, so not much to mention!")
 sect("Self-Check")
 text("Most application configurators provide a self-check function that will check the validity of your configuration and the network connection. You should run this if you are having issues with that device.")
+sect("Config Changes")
+text("When an update adds or removes or otherwise modifies configuration requirements, you will be warned that you need to re-configure. You will not lose any prior data as updates will preserve configurations, you just need to step through the instructions again to add or change any new data.")
 
 target = docs.usage.manual
 sect("Overview")