feat(docs): documentation about new configuration keys

1 files changed, 32 insertions, 9 deletions

diff --git a/docs/whirl/configuration.md b/docs/whirl/configuration.md
index a96ca4b..9764fc0 100644
--- a/docs/whirl/configuration.md
+++ b/docs/whirl/configuration.md
@@ -8,15 +8,6 @@ The server operator's username.
 
 This should NOT be changed under normal circumstances.
 
-### Log Level
-The level of logging which the serve should emit.
-
-By default, **errors**, **warnings**, and **info** (1) logs are emitted, however, you can change
-this value to enable **debug** (2) and **trace** (3) logging.
-
-Under normal circumstances, this value should only be changed when instructed to or if you are
-experiencing any undefined/ unexpected behaviours and you would like to try self-debugging.
-
 ### IP
 **This configuration option may become deprecated in the near:
 [issue](https://github.com/Whirlsplash/whirl/issues/18).**
@@ -27,6 +18,10 @@ When connecting to a local server (client and host both originate from the same
 `0.0.0.0` or `127.0.0.1` is fine, however, if you are hosting a server publicly as service, this
 should be changed to the host's IP address.
 
+### API
+#### Port
+The port on which Whirl's administration and statistics server is listening.
+
 ### Prompt
 #### Enable
 Manually enable the Whirl Shell.
@@ -35,6 +30,34 @@ Manually enable the Whirl Shell.
 Similar to a PS1 as seen in *nix-based operating systems, the Prompt String/ Statement One is the
 prompt string which will appear if you have the Whirl Shell enabled.
 
+### Log
+#### Enable
+Toggle the logging functionality of Whirl.
+
+#### Level
+The level of logging which the serve should emit.
+
+By default, **errors**, **warnings**, and **info** (1) logs are emitted, however, you can change
+this value to enable **debug** (2) and **trace** (3) logs.
+
+Under normal circumstances, this value should only be changed when instructed to or if you are
+experiencing any undefined/ unexpected behaviours and you would like to try self-debugging.
+
+#### Everything
+Enables logging from **ALL** of Whirl and it's dependencies.
+
+It it's default state, false, only Whirl's core crates emit logging information, with this
+configuration key enabled, **ALL** of Whirl's external dependencies will emit logging information.
+
+This configuration key is best left disabled.
+
+#### Test
+Emits a single log for each log level, useful for debugging.
+
+#### File
+If enabled, logs will be emitted to a file within a directory relative to the Whirl binary in a
+directory named `log`. If disabled, logs will be emitted to standard out.
+
 ## Distributor
 ### WorldsMaster Greeting
 The first message or "greeting" which is sent to a user once connected to a WorldServer.