feat(docs): fetch docs from monorepository branches (#103)

Author: innocenzi

.github/workflows/deploy.yml

@@ -2,6 +2,8 @@ name: Deploy
 
 on:
   workflow_dispatch:
+  repository_dispatch:
+    types: [deploy]
 
 jobs:
   deploy:

.gitignore

@@ -1,6 +1,7 @@
 .tempest
 node_modules/
 vendor/
+docs-clone/
 /public/main.css
 /package-lock.json
 .env
@@ -18,4 +19,4 @@ tempest-access.log
 vite-tempest
 public/build/
 database.sqlite
-database-old.sqlite
+database-old.sqlite

bun.lock

@@ -4,22 +4,22 @@
     "": {
       "dependencies": {
         "highlight.js": "^11.11.1",
-        "puppeteer": "24.15.0",
+        "puppeteer": "^24.11.2",
       },
       "devDependencies": {
         "@fontsource-variable/kantumruy-pro": "^5.2.6",
         "@fontsource-variable/public-sans": "^5.2.6",
         "@tailwindcss/typography": "^0.5.16",
         "@tailwindcss/vite": "^4.1.11",
-        "@vitejs/plugin-vue": "6.0.1",
-        "@vueuse/core": "13.6.0",
+        "@vitejs/plugin-vue": "^6.0.0",
+        "@vueuse/core": "^13.5.0",
         "fuse.js": "^7.1.0",
-        "reka-ui": "2.4.1",
+        "reka-ui": "^2.3.2",
         "tailwindcss": "^4.1.11",
         "typescript": "^5.8.3",
         "vite": "^6.3.5",
         "vite-plugin-tempest": "^0.0.2",
-        "vue": "3.5.18",
+        "vue": "^3.5.17",
       },
     },
   },

composer.json

@@ -48,7 +48,8 @@
       "bun run build",
 			"@php ./tempest static:generate",
 			"@php ./tempest static:clean",
-      "rm -rf public/build"
+      "rm -rf public/build",
+			"composer mago:lint"
 		]
 	},
 	"minimum-stability": "dev",

deploy.sh

@@ -15,6 +15,7 @@ php8.4 tempest migrate:up --force
 php8.4 tempest static:clean --force
 
 # Build front-end
+php8.4 tempest docs:pull --no-interaction
 php8.4 tempest command-palette:index
 /home/forge/.bun/bin/bun run build
 php8.4 tempest cache:clear --force

mago.toml

@@ -28,6 +28,12 @@ empty_line_after_opening_tag = false
 default_plugins = true
 plugins = ["symfony", "php-unit"]
 
+# Good rule but needs some work
+[[linter.rules]]
+name = "best-practices/literal-named-argument"
+level = "off"
+# level = "error"
+
 # MAINTENABILITY
 [[linter.rules]]
 name = "maintainability/too-many-enum-cases"

src/Web/Analytics/StatsController.php

@@ -16,7 +16,7 @@
 final readonly class StatsController
 {
     #[Get('/stats')]
-    public function __invoke(Clock $clock): View
+    public function __invoke(): View
     {
         $limit = 30;
 
@@ -44,7 +44,7 @@ public function __invoke(Clock $clock): View
             packageDownloadsPerDay: new Chart(
                 labels: $packageDownloadsPerDay->map(fn (PackageDownloadsPerDay $item) => $item->date->format('Y-m-d')),
                 values: $packageDownloadsPerDay->map(fn (PackageDownloadsPerDay $item) => $item->total),
-                min: $packageDownloadsPerDay->sortByCallback(fn (PackageDownloadsPerDay $a, PackageDownloadsPerDay $b) => $a->total)->first()->total,
+                min: $packageDownloadsPerDay->sortByCallback(fn (PackageDownloadsPerDay $a, PackageDownloadsPerDay $_b) => $a->total)->first()->total,
             ),
         );
     }

src/Web/Blog/BlogPost.php

@@ -7,6 +7,9 @@
 
 use function Tempest\uri;
 
+/**
+ * @mago-expect maintainability/too-many-properties
+ */
 final class BlogPost
 {
     public string $slug;

src/Web/Documentation/.gitignore

@@ -0,0 +1 @@
+content/*

src/Web/Documentation/Chapter.php

@@ -23,7 +23,22 @@ public function __construct(
 
     public function getUri(): string
     {
-        return uri(DocumentationController::class, version: $this->version, category: $this->category, slug: $this->slug);
+        return uri(
+            DocumentationController::class,
+            version: $this->version,
+            category: $this->category,
+            slug: $this->slug,
+        );
+    }
+
+    public function getCanonicalUri(): string
+    {
+        return uri(
+            DocumentationController::class,
+            version: $this->version->default(),
+            category: $this->category,
+            slug: $this->slug,
+        );
     }
 
     public function getMetaUri(): string