From a82b6abc5a0cb57b95ea86bdf994ab060f10d86a Mon Sep 17 00:00:00 2001
From: purple <hello@prpl.wtf>
Date: Tue, 29 Aug 2023 13:14:35 +0200
Subject: [PATCH] Explain what the database values do in migrations.

---
 ...23_04_08_160505_create_blueprint_table.php | 48 +++++++++++++++----
 1 file changed, 40 insertions(+), 8 deletions(-)

diff --git a/database/migrations/2023_04_08_160505_create_blueprint_table.php b/database/migrations/2023_04_08_160505_create_blueprint_table.php
index ff160d7..060f70c 100644
--- a/database/migrations/2023_04_08_160505_create_blueprint_table.php
+++ b/database/migrations/2023_04_08_160505_create_blueprint_table.php
@@ -16,15 +16,47 @@ class CreateBlueprintTable extends Migration
         Schema::dropIfExists('blueprint');
         Schema::create('blueprint', function (Blueprint $table) {
             $table->id();
-
-            $table->string('placeholder')->nullable();
-            $table->string('developer')->nullable();
-            $table->string('telemetry')->nullable();
-            $table->string('panel:id')->nullable();
-            $table->string('version:cache')->nullable();
-            $table->string('notification:text')->nullable();
-
             $table->timestamp('timestamp')->useCurrent()->onUpdate(null);
+
+
+            /*
+              Placeholder may come useful when developing
+              new features, that's why it's currently included
+              in the migrations.
+            */
+            $table->string('placeholder')->nullable();
+
+            /*
+              Database value for keeping track of the developer
+              mode setting.
+            */
+            $table->string('developer')->nullable();
+
+            /*
+              Database value for keeping track of the telemetry
+              opt-out option.
+            */
+            $table->string('telemetry')->nullable();
+
+            /*
+              Randomly generated ID for the panel to use when
+              sending telemetry messages.
+            */
+            $table->string('panel:id')->nullable();
+
+            /*
+              Cache of the previous version name for Blueprint
+              know when to reroll the panel ID and to know when
+              it has updated.
+            */
+            $table->string('version:cache')->nullable();
+
+            /*
+              String for the notification API in Blueprint. Not
+              sure if I'm still using this value, so it might
+              get removed in the future.
+            */
+            $table->string('notification:text')->nullable();
         });
     }