@f5-sales-demo/docs-theme 4.1.6 → 4.3.0

package/components/Banner.astro

@@ -1,7 +1,7 @@
 ---
 import Default from '@astrojs/starlight/components/Banner.astro';
 
-const docsHome = process.env.DOCS_HOME || 'https://f5-sales-demo.github.io/docs/';
+const docsHome = process.env.DOCS_HOME || 'https://f5-sales-demo.github.io/';
 const { sidebar, entry, siteTitle, editUrl } = Astro.locals.starlightRoute;
 const t = Astro.locals.t;
 

package/components/SiteTitle.astro

@@ -2,7 +2,7 @@
 import config from 'virtual:starlight/user-config';
 import { logos } from 'virtual:starlight/user-images';
 
-const docsHome = process.env.DOCS_HOME || 'https://f5-sales-demo.github.io/docs/';
+const docsHome = process.env.DOCS_HOME || 'https://f5-sales-demo.github.io/';
 const { siteTitle } = Astro.locals.starlightRoute;
 ---
 

package/config.ts

@@ -37,6 +37,62 @@ import { buildSubcategorySidebar } from './src/utils/subcategory-sidebar.ts';
 export type { LocaleConfig } from './src/i18n/locales.ts';
 export { f5xcDefaultLocales } from './src/i18n/locales.ts';
 
+interface ProgressiveCorpusPolicy {
+  taxonomy?: {
+    levels: ['category', 'subcategory'];
+    collapseSingletonSubcategories: boolean;
+  };
+  hints?: {
+    strategy: 'first-sentence';
+    maxCharacters: number;
+  };
+}
+
+export function progressiveCorpusPolicy(config: Record<string, unknown>): ProgressiveCorpusPolicy {
+  const value = config.progressiveCorpus;
+  if (value === undefined) return {};
+  if (!value || typeof value !== 'object' || Array.isArray(value)) {
+    throw new Error('[docs-theme] progressiveCorpus configuration must be an object');
+  }
+  const input = value as Record<string, unknown>;
+  const policy: ProgressiveCorpusPolicy = {};
+  if (input.taxonomy !== undefined) {
+    if (!input.taxonomy || typeof input.taxonomy !== 'object' || Array.isArray(input.taxonomy)) {
+      throw new Error('[docs-theme] progressiveCorpus taxonomy is invalid');
+    }
+    const taxonomy = input.taxonomy as Record<string, unknown>;
+    const levels = taxonomy.levels;
+    if (
+      !Array.isArray(levels) ||
+      levels.length !== 2 ||
+      levels[0] !== 'category' ||
+      levels[1] !== 'subcategory' ||
+      typeof taxonomy.collapseSingletonSubcategories !== 'boolean'
+    ) {
+      throw new Error('[docs-theme] progressiveCorpus taxonomy is invalid');
+    }
+    policy.taxonomy = {
+      levels: ['category', 'subcategory'],
+      collapseSingletonSubcategories: taxonomy.collapseSingletonSubcategories,
+    };
+  }
+  if (input.hints !== undefined) {
+    if (!input.hints || typeof input.hints !== 'object' || Array.isArray(input.hints)) {
+      throw new Error('[docs-theme] progressiveCorpus hints are invalid');
+    }
+    const hints = input.hints as Record<string, unknown>;
+    if (
+      hints.strategy !== 'first-sentence' ||
+      !Number.isInteger(hints.maxCharacters) ||
+      (hints.maxCharacters as number) < 1
+    ) {
+      throw new Error('[docs-theme] progressiveCorpus hints are invalid');
+    }
+    policy.hints = { strategy: 'first-sentence', maxCharacters: hints.maxCharacters as number };
+  }
+  return policy;
+}
+
 interface HeadEntry {
   tag: string;
   attrs?: Record<string, string>;
@@ -252,6 +308,12 @@ export const defaultMegaMenuItems: MegaMenuItem[] = [
           title: 'Documentation Tools',
           translations: categoryTitles['Documentation Tools'],
           items: [
+            {
+              label: 'F5 XC Docs',
+              description: 'Organization documentation portal',
+              href: 'https://f5-sales-demo.github.io/',
+              icon: resolveMegaMenuIcon('f5xc:doc'),
+            },
             {
               label: 'Docs Builder',
               translations: itemLabels['Docs Builder'],
@@ -547,10 +609,19 @@ mermaid.initialize({
   },
 ];
 
+export function federatedSearchBundlePaths(site: string, base: string): string[] {
+  const normalizedBase = base.replace(/\/+$/, '');
+  return federatedSearchSites
+    .filter((entry) => (entry.repo === 'f5-sales-demo.github.io' ? '' : `/${entry.repo}`) !== normalizedBase)
+    .map((entry) =>
+      entry.repo === 'f5-sales-demo.github.io' ? `${site}/pagefind/` : `${site}/${entry.repo}/pagefind/`,
+    );
+}
+
 export const federatedSearchSites = [
   { repo: 'docs-builder', label: 'Docs Builder' },
   { repo: 'docs-theme', label: 'Docs Theme' },
-  { repo: 'docs', label: 'F5 XC Docs' },
+  { repo: 'f5-sales-demo.github.io', label: 'F5 XC Docs' },
   { repo: 'administration', label: 'Administration' },
   { repo: 'nginx', label: 'NGINX' },
   { repo: 'observability', label: 'Observability' },
@@ -633,6 +704,7 @@ export function createF5xcDocsConfig(options: F5xcDocsConfigOptions = {}) {
 
   const federatedSearch = options.federatedSearch !== false;
   const normalizedBase = base.replace(/\/+$/, '');
+  const repositoryCorpusPolicy = progressiveCorpusPolicy(llmsConfig);
   const progressiveCorpus =
     options.progressiveCorpus ||
     (process.env.MACHINE_CORPUS_DIR
@@ -642,6 +714,7 @@ export function createF5xcDocsConfig(options: F5xcDocsConfigOptions = {}) {
           assetBaseUrl: `${normalizedBase}/snapshot/`,
           title,
           description,
+          ...repositoryCorpusPolicy,
           sources: {
             'docs-cloud-f5-com': {
               title: 'F5 Distributed Cloud Documentation',
@@ -655,11 +728,7 @@ export function createF5xcDocsConfig(options: F5xcDocsConfigOptions = {}) {
         }
       : undefined);
   const mergeIndex = federatedSearch
-    ? federatedSearchSites
-        .filter((s) => `/${s.repo}` !== normalizedBase)
-        .map((s) => ({
-          bundlePath: `${site}/${s.repo}/pagefind/`,
-        }))
+    ? federatedSearchBundlePaths(site, base).map((bundlePath) => ({ bundlePath }))
     : undefined;
 
   const starlightPlugins: StarlightPlugin[] = [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@f5-sales-demo/docs-theme",
-  "version": "4.1.6",
+  "version": "4.3.0",
   "description": "F5 Distributed Cloud branded Starlight documentation theme",
   "type": "module",
   "engines": {
@@ -139,7 +139,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.1.0",
+    "@f5-sales-demo/starlight-llms-txt": "2.2.0",
     "@f5-sales-demo/starlight-mega-menu": "^3.0.0",
     "gray-matter": "^4.0.3",
     "remark-code-import": "^1.2.0",