Document realtime compiler config options

hydephp · Oct 22, 2023 · cedc566 · cedc566
1 parent 1d3ef39
commit cedc566
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 2 deletions.
diff --git a/config/hyde.php b/config/hyde.php
@@ -403,11 +403,22 @@
     */
 
     'server' => [
+        // The default port the preview is served on
         'port' => env('SERVER_PORT', 8080),
+
+        // The default host the preview is served on
         'host' => env('SERVER_HOST', 'localhost'),
+
+        // Should the realtime compiler dashboard be enabled?
         'dashboard' => env('SERVER_DASHBOARD', true),
+
+        // Can the dashboard make edits to the project file system?
         'dashboard_editor' => true,
+
+        // Should the dashboard show tips?
         'dashboard_tips' => true,
+
+        // Should preview pages be saved to the output directory?
         'save_preview' => true,
     ],
 

diff --git a/packages/framework/config/hyde.php b/packages/framework/config/hyde.php
@@ -403,11 +403,22 @@
     */
 
     'server' => [
+        // The default port the preview is served on
         'port' => env('SERVER_PORT', 8080),
+
+        // The default host the preview is served on
         'host' => env('SERVER_HOST', 'localhost'),
+
+        // Should the realtime compiler dashboard be enabled?
         'dashboard' => env('SERVER_DASHBOARD', true),
+
+        // Can the dashboard make edits to the project file system?
         'dashboard_editor' => true,
+
+        // Should the dashboard show tips?
         'dashboard_tips' => true,
+
+        // Should preview pages be saved to the output directory?
         'save_preview' => true,
     ],
 

diff --git a/packages/realtime-compiler/src/Http/DashboardController.php b/packages/realtime-compiler/src/Http/DashboardController.php
@@ -54,8 +54,8 @@ class DashboardController
         'This dashboard won\'t be saved to your static site.',
         'Got stuck? Ask for help on [GitHub](https://github.com/hydephp/hyde)!',
         'Found a bug? Please report it on [GitHub](https://github.com/hydephp/hyde)!',
-        'You can disable tips using by setting `server.tips` to `false` in `config/hyde.php`.',
-        'The dashboard can make changes to your project files. You can disable this by setting `server.editor` to `false` in `config/hyde.php`.',
+        'You can disable tips using by setting `server.dashboard_tips` to `false` in `config/hyde.php`.',
+        'The dashboard update your project files. You can disable this by setting `server.dashboard_editor` to `false` in `config/hyde.php`.',
     ];
 
     public function __construct()