@f5-sales-demo/docs-theme 4.4.12 → 4.5.0

package/canonical-route-middleware.ts

@@ -13,6 +13,17 @@ export const onRequest = defineRouteMiddleware(async (context, next) => {
     providerNavigation ||= JSON.parse(fs.readFileSync(process.env.PROVIDER_NAVIGATION || '', 'utf8'));
     const metadata = entry.data.xcsh_docs;
     const base = import.meta.env.BASE_URL;
+    const slug = route.id.replace(/\/$/, '');
+    const scope = metadata ? slug || '_llms-txt/root' : null;
+    route.head.push({
+      tag: 'link',
+      attrs: {
+        rel: 'describedby',
+        href: scope
+          ? `${base.replace(/\/$/, '')}/${scope}/_llms/content/llms.txt`
+          : `${base.replace(/\/$/, '')}/llms.txt`,
+      },
+    });
     const sections = stagedProviderSections().map((section) => ({
       type: 'link' as const,
       label: section.label,

package/config.ts

@@ -31,6 +31,7 @@ import {
 } from './src/i18n/mega-menu-translations.ts';
 import { sidebarTranslations } from './src/i18n/translations.ts';
 import remarkMermaid from './src/plugins/remark-mermaid.mjs';
+import canonicalLlms from './src/utils/canonical-llms.mjs';
 import { providerMegaMenu } from './src/utils/canonical-provider.ts';
 import { menuLocalizationPolicy } from './src/utils/menu-localization.ts';
 import { stagedProviderSections } from './src/utils/provider-sections.ts';
@@ -933,7 +934,9 @@ export function createF5xcDocsConfig(options: F5xcDocsConfigOptions = {}) {
         ],
       }),
       react(),
-      ...(canonicalProvider ? [providerSharedAssets()] : []),
+      ...(canonicalProvider
+        ? [providerSharedAssets(), canonicalLlms({ contentRoot: canonicalProvider.contentRoot, base, title })]
+        : []),
       ...additionalIntegrations,
     ],
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@f5-sales-demo/docs-theme",
-  "version": "4.4.12",
+  "version": "4.5.0",
   "description": "F5 Distributed Cloud branded Starlight documentation theme",
   "type": "module",
   "engines": {
@@ -144,7 +144,7 @@
     "@anthropic-ai/sdk": "^0.121.0",
     "@astrojs/react": "^6.0.4",
     "@f5-sales-demo/i18n-core": "^1.0.56",
-    "@f5-sales-demo/starlight-llms-txt": "2.2.0",
+    "@f5-sales-demo/starlight-llms-txt": "2.3.0",
     "@f5-sales-demo/starlight-mega-menu": "^3.0.0",
     "gray-matter": "^4.0.3",
     "remark-code-import": "^1.2.0",

package/src/utils/canonical-llms.mjs

@@ -0,0 +1,18 @@
+import { fileURLToPath } from 'node:url';
+import { readCanonicalCorpus, writeCanonicalHierarchy } from '@f5-sales-demo/starlight-llms-txt/canonical-corpus';
+
+export default function canonicalLlms({ contentRoot, base, title }) {
+  return {
+    name: 'f5-canonical-llms',
+    hooks: {
+      'astro:config:setup'() {
+        // Validate before Astro starts processing staged content.
+        const corpus = readCanonicalCorpus(contentRoot);
+        if (!corpus.pages.length) throw new Error('Canonical publication has no pages');
+      },
+      'astro:build:done'({ dir }) {
+        writeCanonicalHierarchy({ contentRoot, outputRoot: fileURLToPath(dir), base, title });
+      },
+    },
+  };
+}

package/src/utils/canonical-llms.test.ts

@@ -0,0 +1,24 @@
+import { describe, expect, it, vi } from 'vitest';
+
+const read = vi.fn(() => ({ pages: [{}] }));
+const write = vi.fn();
+vi.mock('@f5-sales-demo/starlight-llms-txt/canonical-corpus', () => ({
+  readCanonicalCorpus: read,
+  writeCanonicalHierarchy: write,
+}));
+describe('canonical llms integration', () => {
+  it('validates the original root before processing and streams after the build', async () => {
+    const { default: integration } = await import('./canonical-llms.mjs');
+    const plugin = integration({ contentRoot: '/fixture/documentation', base: '/preview/', title: 'Fixture' });
+    expect(read).not.toHaveBeenCalled();
+    plugin.hooks['astro:config:setup']();
+    expect(read).toHaveBeenCalledWith('/fixture/documentation');
+    plugin.hooks['astro:build:done']({ dir: new URL('file:///fixture/output/') });
+    expect(write).toHaveBeenCalledWith({
+      contentRoot: '/fixture/documentation',
+      outputRoot: '/fixture/output/',
+      base: '/preview/',
+      title: 'Fixture',
+    });
+  });
+});