write doc comments

Author: SKairinos

.submodules/__main__.py

@@ -2,7 +2,15 @@
 © Ocado Group
 Created on 02/03/2024 at 23:46:28(+00:00).
 
-TODO: write script description.
+This file is used to configure CFL's submodules using the global-config defined
+in the config.jsonc file in this directory.
+
+By default, the global-config is *merged* into any existing config within each
+submodule. That is, any values defined in the global-config will override the
+values found in a submodule's config but if a submodule has key:value pairs not
+present in the global-config, they will remain. However, in some cases, the
+behavior is to override the values (values not present in the global-config will
+be removed).  
 """
 
 import json

.submodules/config.jsonc

@@ -1,4 +1,18 @@
-// TODO: Write comment
+// This file is used to define a global-config for the submodules within CFL's
+// workspace. This saves us having to manually repeat common configurations
+// across 2+ submodules and avoids human error when accidentally copy/pasting
+// something incorrectly.
+//
+// WARNING: This file is written in JSONC format (JSON with comments). However,
+//  only single lines comments with no preceding text are allowed. For example:
+//  - "// single-line comment, no preceding text" ✅
+//  - "{"age": 27} // single-line comment, some preceding text" 🚫
+//  - "/* multi-line comment, no preceding text */" 🚫
+//  - "{"age": 27} /* multi-line comment, some preceding text */" 🚫
+//
+// This config is processed by the __main__.py file in this directory. To
+// understand more about this shape of the config data and how it's processed,
+// please read __main__.py.
 {
   "base": {
     "description": "Base configuration to be inherited by all other configurations.",