Restructure docs routes and add metadata helper

Move docs routing from a single [...slug] handler to explicit [plugin]/[version]/[...slug], plus lightweight [plugin]/[version] and [plugin] pages that redirect to overview and provide static params. Add a shared metadata helper (app/docs/components/helpers.ts) and an index export for docs components. Update page logic to build params from plugin/version/slug, use generateMetadataForPlugin, and adjust imports. Add a workflow step to verify the ./out directory before uploading the Pages artifact and add debug logging to next.config.mjs.

Author: cklei-carly

.github/workflows/deploy.yml

@@ -45,6 +45,13 @@ jobs:
           NEXT_STATIC_EXPORT: "true"
           NODE_ENV: "production"
 
+      - name: Verify output directory
+        run: |
+          if [ ! -d "./out" ]; then
+            echo "Error: Output directory './out' does not exist."
+            exit 1
+          fi
+
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:

app/docs/[...slug]/page.tsx …cs/[plugin]/[version]/[...slug]/page.tsxapp/docs/[...slug]/page.tsx renamed to app/docs/[plugin]/[version]/[...slug]/page.tsx app/docs/[...slug]/page.tsx renamed to app/docs/[plugin]/[version]/[...slug]/page.tsx

@@ -5,31 +5,22 @@ import { getMDXComponents } from '@/mdx-components';
 import type { Metadata } from 'next';
 import { createCustomRelativeLink } from '@/lib/mdx-link';
 import Link from 'next/link';
-import { ViewOptions } from '../components/page-actions';
+import { ViewOptions, generateMetadataForPlugin } from '@/app/docs/components';
 
-export default async function Page(props: PageProps<'/docs/[...slug]'>) {
+type CurrentPageProps = PageProps<'/docs/[plugin]/[version]/[...slug]'>;
+
+export default async function Page(props: CurrentPageProps) {
   const params = await props.params;
+  const pluginName = params.plugin;
+  const version = params.version;
   const slugs = params.slug || [];
-  const pluginName = slugs[0];
-  const version = slugs[1] ?? null;
-  const restSlugs = version ? slugs.slice(2) : slugs.slice(1);
-
-  // If version is not specified, try redirect to latest version
-  if (!version) {
-    const latestVersion = getLatestVersion(pluginName);
-    if (!latestVersion) {
-      // Plugin doesn't exist, show 404
-      return notFound();
-    }
-    return redirect(`/docs/${[pluginName, latestVersion].join('/')}`);
-  }
 
   // If missing which page to load, default to 'overview'
-  if (restSlugs.length === 0) {
+  if (slugs.length === 0) {
     return redirect(`/docs/${[pluginName, version, 'overview'].join('/')}`);
   }
 
-  const finalSlugs = [pluginName, version, ...restSlugs];
+  const finalSlugs = [pluginName, version, ...slugs];
   const page = source.getPage(finalSlugs);
 
   // console.debug('Resolved final slugs for page:', finalSlugs, { pageExists: !!page });
@@ -72,24 +63,36 @@ export default async function Page(props: PageProps<'/docs/[...slug]'>) {
 }
 
 export async function generateStaticParams() {
-  return source.generateParams();
+  const slugs = source.generateParams();
+  const params: { plugin: string, version: string, slug: string[] }[] = [];
+
+  Array.from(slugs).forEach((array) => {
+    const slugArray = array['slug'];
+    const plugin = slugArray[0];
+    const version = slugArray[1];
+    const rest = slugArray.slice(2);
+    params.push({ plugin, version, slug: rest });
+  });
+
+  return params;
 }
 
-export async function generateMetadata(props: PageProps<'/docs/[...slug]'>): Promise<Metadata> {
+export async function generateMetadata(props: CurrentPageProps): Promise<Metadata> {
   const params = await props.params;
-  const slugs = params.slug || [];
-  const pluginName = slugs[0];
-  const page = source.getPage(slugs);
-  if (!page) notFound();
+  const pluginName = params.plugin;
+
+  return generateMetadataForPlugin(pluginName) ?? notFound();
+  // const page = source.getPage([pluginName, version, ...slugs]);
+  // if (!page) notFound();
 
-  return {
-    title: page.data.title,
-    description: page.data.description,
-    openGraph: {
-      images: [
-        getPluginImage(pluginName).url, 
-        // getPageImage(page).url,
-      ],
-    },
-  };
+  // return {
+  //   title: page.data.title,
+  //   description: page.data.description,
+  //   openGraph: {
+  //     images: [
+  //       getPluginImage(pluginName).url, 
+  //       // getPageImage(page).url,
+  //     ],
+  //   },
+  // };
 }

app/docs/[plugin]/[version]/page.tsx

@@ -0,0 +1,33 @@
+import { notFound, redirect } from 'next/navigation';
+import type { Metadata } from 'next';
+import { config } from '@/lib/config';
+import { generateMetadataForPlugin } from '@/app/docs/components';
+
+type CurrentPageProps = PageProps<'/docs/[plugin]/[version]'>;
+
+export default async function Page(props: CurrentPageProps) {
+  const params = await props.params;
+  const pluginName = params.plugin;
+  const version = params.version;
+
+  return redirect(`/docs/${[pluginName, version, 'overview'].join('/')}`);
+}
+
+export async function generateStaticParams() {
+  const params: { plugin: string, version: string }[] = [];
+
+  for (const plugin of config.plugins) {
+    for (const version of plugin.versions) {
+      params.push({ plugin: plugin.id, version: version.version });
+    }
+  }
+
+  return params;
+}
+
+export async function generateMetadata(props: CurrentPageProps): Promise<Metadata> {
+
+  const params = await props.params;
+  const pluginName = params.plugin;
+  return generateMetadataForPlugin(pluginName) ?? notFound();
+}

app/docs/[plugin]/page.tsx

@@ -0,0 +1,35 @@
+import { getLatestVersion } from '@/lib/source';
+import { notFound, redirect } from 'next/navigation';
+import type { Metadata } from 'next';
+import { config } from '@/lib/config';
+import { generateMetadataForPlugin } from '@/app/docs/components';
+
+type CurrentPageProps = PageProps<'/docs/[plugin]'>;
+
+export default async function Page(props: CurrentPageProps) {
+  const params = await props.params;
+  const pluginName = params.plugin;
+
+  const latestVersion = getLatestVersion(pluginName);
+  if (!latestVersion) {
+    return notFound();
+  }
+  return redirect(`/docs/${[pluginName, latestVersion].join('/')}`);
+}
+
+export async function generateStaticParams() {
+  const params: { plugin: string }[] = [];
+
+  for (const plugin of config.plugins) {
+    params.push({ plugin: plugin.id });
+  }
+
+  return params;
+}
+
+export async function generateMetadata(props: CurrentPageProps): Promise<Metadata> {
+  const params = await props.params;
+  const pluginName = params.plugin;
+
+  return generateMetadataForPlugin(pluginName) ?? notFound();
+}

app/docs/components/helpers.ts

@@ -0,0 +1,17 @@
+import { config } from "@/lib/config";
+import { getPluginImage } from "@/lib/source";
+
+export function generateMetadataForPlugin(plugin: string) {
+  const pluginConfig = config.plugins.find(p => p.id === plugin);
+  if (!pluginConfig) return null;
+  return {
+    title: pluginConfig.name,
+    description: pluginConfig.description,
+    // openGraph: {
+    //   images: [
+    //     getPluginImage(plugin).url, 
+    //     // getPageImage(page).url,
+    //   ],
+    // },
+  };
+};

app/docs/components/index.ts

@@ -0,0 +1,2 @@
+export * from './page-actions';
+export * from './helpers';

next.config.mjs

@@ -5,6 +5,10 @@ const withMDX = createMDX();
 const isStaticExport = process.env.NEXT_STATIC_EXPORT === "true";
 const isProd = process.env.NODE_ENV === "production";
 
+console.debug("Next.js Configuration:");
+console.debug(`  isProd: ${isProd}`);
+console.debug(`  isStaticExport: ${isStaticExport}`);
+
 // GitHub Pages configuration
 const basePath =
   isProd && isStaticExport