Merge pull request #1979 from hydephp/improve-documentation-generator-script

emmadesilva · web-flow · commit f694dff4aebe · 2024-10-05T13:09:13.000+02:00
Internal: Improve documentation generator script to update the kernel overview page
diff --git a/docs/architecture-concepts/the-hydekernel.md b/docs/architecture-concepts/the-hydekernel.md
@@ -53,10 +53,12 @@ You can read all about it in the [Autodiscovery Documentation](autodiscovery).
 Since the most common way to interact with the kernel is through the Hyde facade, we will use that for the examples.
 But you could just as well chain the methods on the accessed kernel singleton instance if you wanted.
 
+<!-- Start generated docs for the HydeKernel -->
+
 <section id="hyde-kernel-base-methods">
 
 <!-- Start generated docs for Hyde\Foundation\HydeKernel -->
-<!-- Generated by HydePHP DocGen script at 2023-03-11 11:09:45 in 2.53ms -->
+<!-- Generated by HydePHP DocGen script at 2024-07-08 20:47:38 in 2.89ms -->
 
 #### `version()`
 
@@ -87,7 +89,7 @@ Hyde::features(): Hyde\Facades\Features
 No description provided.
 
 ```php
-Hyde::hasFeature(string $feature): bool
+Hyde::hasFeature(Hyde\Enums\Feature|string $feature): bool
 ```
 
 #### `toArray()`
@@ -105,30 +107,30 @@ Hyde::toArray(): array<TKey, TValue>
 <section id="hyde-kernel-foundation-methods">
 
 <!-- Start generated docs for Hyde\Foundation\Concerns\HandlesFoundationCollections -->
-<!-- Generated by HydePHP DocGen script at 2023-03-11 11:14:55 in 0.06ms -->
+<!-- Generated by HydePHP DocGen script at 2024-07-17 15:27:42 in 0.04ms -->
 
 #### `files()`
 
 No description provided.
 
 ```php
-Hyde::files(): \Hyde\Foundation\Kernel\FileCollection<string, \Hyde\Support\Filesystem\ProjectFile>
+Hyde::files(): Hyde\Foundation\Kernel\FileCollection
 ```
 
 #### `pages()`
 
 No description provided.
 
 ```php
-Hyde::pages(): \Hyde\Foundation\Kernel\PageCollection<string, \Hyde\Pages\Concerns\HydePage>
+Hyde::pages(): Hyde\Foundation\Kernel\PageCollection
 ```
 
 #### `routes()`
 
 No description provided.
 
 ```php
-Hyde::routes(): \Hyde\Foundation\Kernel\RouteCollection<string, \Hyde\Support\Models\Route>
+Hyde::routes(): Hyde\Foundation\Kernel\RouteCollection
 ```
 
 <!-- End generated docs for Hyde\Foundation\Concerns\HandlesFoundationCollections -->
@@ -187,7 +189,7 @@ Hyde::markdown(string $text, bool $normalizeIndentation): Illuminate\Support\Htm
 <section id="hyde-kernel-hyperlink-methods">
 
 <!-- Start generated docs for Hyde\Foundation\Concerns\ForwardsHyperlinks -->
-<!-- Generated by HydePHP DocGen script at 2023-03-11 11:17:34 in 0.09ms -->
+<!-- Generated by HydePHP DocGen script at 2024-02-25 19:02:29 in 0.09ms -->
 
 #### `formatLink()`
 
@@ -229,6 +231,14 @@ No description provided.
 Hyde::url(string $path): string
 ```
 
+#### `route()`
+
+No description provided.
+
+```php
+Hyde::route(string $key): Hyde\Support\Models\Route
+```
+
 #### `hasSiteUrl()`
 
 No description provided.
@@ -557,3 +567,5 @@ Hyde::booted(callable(\Hyde\Foundation\HydeKernel): void): void
 <!-- End generated docs for Hyde\Foundation\Concerns\BootsHydeKernel -->
 
 </section>
+
+<!-- End generated docs for the HydeKernel -->
diff --git a/monorepo/scripts/docs/DocGen.php b/monorepo/scripts/docs/DocGen.php
@@ -152,6 +152,45 @@
     generate($options);
 }
 
+// Update the HydeKernel page
+(function (): void {
+    echo "\n\033[33mUpdating the HydeKernel page...\033[0m";
+
+    $pages = [
+        'hyde-kernel-base-methods',
+        'hyde-kernel-foundation-methods',
+        'hyde-kernel-string-methods',
+        'hyde-kernel-hyperlink-methods',
+        'hyde-kernel-filesystem-methods',
+        'hyde-kernel-kernel-methods',
+        'hyde-kernel-extensions-methods',
+        'hyde-kernel-view-methods',
+        'hyde-kernel-boot-methods',
+    ];
+
+    $page = 'docs/architecture-concepts/the-hydekernel.md';
+
+    // Replace everything between <!-- Start generated docs for the HydeKernel --> and <!-- End generated docs for the HydeKernel -->
+    // With the concatenated content of the partials
+
+    $startMarker = '<!-- Start generated docs for the HydeKernel -->';
+    $endMarker = '<!-- End generated docs for the HydeKernel -->';
+
+    $rootPath = realpath(__DIR__.'/../../../');
+
+    $content = '';
+    foreach ($pages as $partial) {
+        $content .= trim(file_get_contents($rootPath.'/docs/_data/partials/hyde-pages-api/'.$partial.'.md'))."\n\n";
+    }
+
+    $file = file_get_contents($page);
+    $file = preg_replace('/<!-- Start generated docs for the HydeKernel -->.*<!-- End generated docs for the HydeKernel -->/s', $startMarker."\n\n".$content.$endMarker, $file);
+
+    file_put_contents($page, $file);
+
+    echo " \033[37mDone!\033[0m\n";
+})();
+
 // Assemble end time in milliseconds
 $timeEnd = microtime(true);
 $time = number_format(($timeEnd - $timeStart) * 1000, 2);
