@f5-sales-demo/docs-theme 4.4.9 → 4.4.11

package/config.ts

@@ -32,6 +32,7 @@ import {
 import { sidebarTranslations } from './src/i18n/translations.ts';
 import remarkMermaid from './src/plugins/remark-mermaid.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';
 import { resolveMegaMenuIcon } from './src/utils/resolve-icon.ts';
 import providerSharedAssets from './src/utils/share-provider-assets.mjs';
@@ -670,7 +671,7 @@ export function createF5xcDocsConfig(options: F5xcDocsConfigOptions = {}) {
   }
   const site = options.site || process.env.DOCS_SITE || 'https://f5-sales-demo.github.io';
   const base = options.base || process.env.DOCS_BASE || '/';
-  const title = options.title || process.env.DOCS_TITLE || 'Documentation';
+  const title = options.title || process.env.DOCS_TITLE || (canonicalProvider ? 'Terraform Provider' : 'Documentation');
   const description = options.description || process.env.DOCS_DESCRIPTION || '';
   const githubRepository = options.githubRepository || process.env.GITHUB_REPOSITORY || '';
   let llmsOptionalLinks: Array<{ title: string; url: string }> = options.llmsOptionalLinks || [];
@@ -716,7 +717,7 @@ export function createF5xcDocsConfig(options: F5xcDocsConfigOptions = {}) {
   const megaMenuItems =
     options.megaMenuItems ||
     (canonicalProvider
-      ? providerMegaMenu(base, stagedProviderSections(canonicalProvider.manifest))
+      ? [...defaultMegaMenuItems, ...providerMegaMenu(base, stagedProviderSections(canonicalProvider.manifest))]
       : defaultMegaMenuItems);
   const head = options.head || (canonicalProvider ? [] : defaultHead);
   const logo = options.logo || { src: '@f5-sales-demo/docs-theme/assets/f5-distributed-cloud.svg' };
@@ -874,13 +875,17 @@ export function createF5xcDocsConfig(options: F5xcDocsConfigOptions = {}) {
   return defineConfig({
     site,
     base,
+    vite: { plugins: [menuLocalizationPolicy()], ...(canonicalProvider ? { build: { assetsInlineLimit: 0 } } : {}) },
     ...(canonicalProvider
       ? {
           experimental: { collectionStorage: { type: 'chunked' as const, chunkSize: 1024 * 1024 } },
-          vite: { build: { assetsInlineLimit: 0 } },
         }
       : {}),
-    ...(resolvedLocales ? { redirects: { '/': `${normalizedBase}/${resolvedDefaultLocale}/` } } : {}),
+    ...(canonicalProvider
+      ? { redirects: { '/en/': `${normalizedBase}/` } }
+      : resolvedLocales
+        ? { redirects: { '/': `${normalizedBase}/${resolvedDefaultLocale}/` } }
+        : {}),
     markdown: {
       processor: unified({
         remarkPlugins: [remarkMermaid, [codeImport, { allowImportingFromOutside: true }], ...additionalRemarkPlugins],

package/index.ts

@@ -26,7 +26,6 @@ export default function f5xcDocsTheme(): StarlightPlugin {
             ...config.components,
             ...(process.env.DOCS_PROFILE === 'canonical-provider'
               ? {
-                  Header: '@f5-sales-demo/docs-theme/components/ProviderHeader.astro',
                   Sidebar: '@f5-sales-demo/docs-theme/components/ProviderSidebar.astro',
                 }
               : {}),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@f5-sales-demo/docs-theme",
-  "version": "4.4.9",
+  "version": "4.4.11",
   "description": "F5 Distributed Cloud branded Starlight documentation theme",
   "type": "module",
   "engines": {

package/src/utils/localize-ecosystem-href.test.ts

@@ -79,3 +79,10 @@ describe('localizeEcosystemHref', () => {
     );
   });
 });
+
+it('leaves the single-locale mvp menu destination unlocalized', () => {
+  for (const locale of ['en', 'fr'])
+    expect(localizeEcosystemHref('https://f5-sales-demo.github.io/mvp/', locale)).toBe(
+      'https://f5-sales-demo.github.io/mvp/',
+    );
+});

package/src/utils/localize-ecosystem-href.ts

@@ -5,7 +5,7 @@ const ECOSYSTEM_HOST = 'f5-sales-demo.github.io';
 // Ecosystem sites published as a single locale (no `/<locale>/` path segment).
 // Injecting a locale slug into links to these produces a 404
 // (e.g. `/terraform-provider-xcsh/en/`), so they are left unlocalized.
-const NON_LOCALIZED_ECOSYSTEM_SLUGS = new Set(['terraform-provider-xcsh', 'docs-control', 'html-to-markdown']);
+const NON_LOCALIZED_ECOSYSTEM_SLUGS = new Set(['terraform-provider-xcsh', 'docs-control', 'html-to-markdown', 'mvp']);
 
 export const langToSlug = bcp47ToSlug;
 

package/src/utils/menu-localization.test.ts

@@ -0,0 +1,15 @@
+import { expect, it } from 'vitest';
+import { menuLocalizationPolicy } from './menu-localization';
+
+it('routes archived desktop and mobile menu localization through the theme policy', () => {
+  const plugin = menuLocalizationPolicy();
+  for (const name of ['MegaMenu.tsx', 'MegaMenuMobile.tsx']) {
+    expect(
+      plugin.resolveId(
+        '../libs/localize-ecosystem-href.ts',
+        `/app/node_modules/@f5-sales-demo/starlight-mega-menu/components/${name}`,
+      ),
+    ).toMatch(/localize-ecosystem-href\.ts$/);
+  }
+  expect(plugin.resolveId('../libs/localize-ecosystem-href.ts', '/app/other.ts')).toBeUndefined();
+});

package/src/utils/menu-localization.ts

@@ -0,0 +1,16 @@
+import { fileURLToPath } from 'node:url';
+
+// The archived menu package has a separate localizer that blindly adds language
+// paths. Route both its desktop and mobile components through the theme policy.
+export function menuLocalizationPolicy() {
+  return {
+    name: 'f5-menu-localization-policy',
+    enforce: 'pre' as const,
+    resolveId(source: string, importer?: string) {
+      if (importer?.includes('/starlight-mega-menu/') && /(?:^|\/)localize-ecosystem-href(?:\.ts)?$/.test(source)) {
+        return fileURLToPath(new URL('./localize-ecosystem-href.ts', import.meta.url));
+      }
+      return undefined;
+    },
+  };
+}