chore: Cleanup docs (#1284)

Author: TartanLlama

documentation/app/c-at-e-file-server.js

@@ -1,4 +1,44 @@
 import parseRange from 'range-parser'
+import versionRedirects from './version-redirects.json'
+
+/**
+ * Check if the request path is for an old minor version and should be redirected
+ * to the latest minor version within the same major version.
+ * @param {Request} request - The incoming request
+ * @returns {Response | null} - Returns a redirect Response if applicable, else null
+ */
+function redirectMinorVersions(request) {
+    const url = new URL(request.url);
+    const pathMatch = url.pathname.match(/^\/docs\/([^\/]+)(\/.*)?$/);
+    
+    if (!pathMatch) {
+        return null;
+    }
+    
+    const [, version, restOfPath = ''] = pathMatch;
+    
+    const majorVersion = version.split('.')[0];
+    const targetVersion = versionRedirects.latestByMajor[majorVersion];
+    
+    if (targetVersion === null || (targetVersion && targetVersion !== version)) {
+        // Construct the new URL with the latest version
+        const versionPrefix = targetVersion === null ? '' : `/${targetVersion}`;
+        const newPath = `/docs${versionPrefix}${restOfPath}`;
+        const newUrl = new URL(newPath, url.origin);
+        newUrl.search = url.search; // Preserve query parameters
+        
+        // Return a 301 permanent redirect
+        return new Response(null, {
+            status: 301,
+            headers: {
+                'Location': newUrl.toString(),
+                'Cache-Control': 'public, max-age=3600'
+            }
+        });
+    }
+    
+    return null;
+}
 
 /**
  * Attempt to locate the requested resource from a Fastly KV Store,
@@ -15,6 +55,12 @@ export async function get(store_name, request) {
         return null
     }
 
+    // Check if this request should be redirected to a newer minor version
+    const redirect = redirectMinorVersions(request);
+    if (redirect) {
+        return redirect;
+    }
+
     // if path ends in / or does not have an extension
     // then append /index.html to the end so we can serve a page
     let path = new URL(request.url).pathname

documentation/app/version-redirects.json

@@ -0,0 +1,7 @@
+{
+  "latestByMajor": {
+    "1": "1.13.0",
+    "2": "2.5.0",
+    "3": null
+  }
+}

documentation/generate-version-redirects.mjs

@@ -0,0 +1,26 @@
+#!/usr/bin/env node
+
+import { readFileSync, writeFileSync } from 'fs';
+import { join, dirname } from 'path';
+import { fileURLToPath } from 'url';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+const versionsPath = join(__dirname, 'versions.json');
+const versions = JSON.parse(readFileSync(versionsPath, 'utf-8'));
+
+// Find latest version for each major version (versions.json is already sorted newest first)
+const latestByMajor = {};
+for (const version of versions) {
+  const major = version.split('.')[0];
+  if (!latestByMajor[major]) {
+    latestByMajor[major] = version;
+  }
+}
+
+// Latest major redirects to /docs/ (no version in path)
+const latestMajor = Math.max(...Object.keys(latestByMajor).map(Number));
+latestByMajor[latestMajor] = null;
+
+const outputPath = join(__dirname, 'app', 'version-redirects.json');
+writeFileSync(outputPath, JSON.stringify({ latestByMajor }, null, 2));

documentation/package-lock.json

@@ -2,15 +2,16 @@
   "scripts": {
     "docusaurus": "docusaurus",
     "start": "docusaurus start",
-    "build": "node --max-old-space-size=8000 node_modules/.bin/docusaurus build",
+    "build": "node --max-old-space-size=8000 node_modules/.bin/docusaurus build && npm run generate-version-redirects",
     "swizzle": "docusaurus swizzle",
     "deploy": "npm run build && cd app && npm install && npm run deploy",
     "clear": "docusaurus clear",
     "serve": "docusaurus serve",
     "write-translations": "docusaurus write-translations",
     "write-heading-ids": "docusaurus write-heading-ids",
     "remove-fastly-prefix": "node rename-docs.mjs remove-prefix",
-    "add-fastly-prefix": "node rename-docs.mjs add-prefix"
+    "add-fastly-prefix": "node rename-docs.mjs add-prefix",
+    "generate-version-redirects": "node generate-version-redirects.mjs"
   },
   "devDependencies": {
     "@cmfcmf/docusaurus-search-local": "^2.0.1",