@f5-sales-demo/docs-theme 4.0.17 → 4.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/config.ts CHANGED
@@ -58,6 +58,14 @@ export interface F5xcDocsConfigOptions {
58
58
  federatedSearch?: boolean;
59
59
  locales?: Record<string, { label: string; lang: string; dir?: 'rtl' }> | false;
60
60
  defaultLocale?: string;
61
+ progressiveCorpus?: {
62
+ manifest: string;
63
+ contentRoot: string;
64
+ assetBaseUrl?: string;
65
+ title?: string;
66
+ description?: string;
67
+ sources?: Record<string, { title?: string; description?: string }>;
68
+ };
61
69
  }
62
70
 
63
71
  const developerAutomationTranslations = Object.fromEntries(
@@ -252,6 +260,14 @@ export const defaultMegaMenuItems: MegaMenuItem[] = [
252
260
  href: 'https://f5-sales-demo.github.io/docs-builder/',
253
261
  icon: resolveMegaMenuIcon('f5xc:doc'),
254
262
  },
263
+ {
264
+ label: 'F5 Docs Corpus',
265
+ translations: itemLabels['F5 Docs Corpus'],
266
+ description: 'Machine-readable F5 product documentation',
267
+ descriptionTranslations: itemDescriptions['Machine-readable F5 product documentation'],
268
+ href: 'https://f5-sales-demo.github.io/html-to-markdown/',
269
+ icon: resolveMegaMenuIcon('f5xc:doc'),
270
+ },
255
271
  {
256
272
  label: 'Docs Theme',
257
273
  translations: itemLabels['Docs Theme'],
@@ -617,6 +633,27 @@ export function createF5xcDocsConfig(options: F5xcDocsConfigOptions = {}) {
617
633
 
618
634
  const federatedSearch = options.federatedSearch !== false;
619
635
  const normalizedBase = base.replace(/\/+$/, '');
636
+ const progressiveCorpus =
637
+ options.progressiveCorpus ||
638
+ (process.env.MACHINE_CORPUS_DIR
639
+ ? {
640
+ manifest: path.join(process.env.MACHINE_CORPUS_DIR, 'manifest.json'),
641
+ contentRoot: process.env.MACHINE_CORPUS_DIR,
642
+ assetBaseUrl: `${normalizedBase}/snapshot/`,
643
+ title,
644
+ description,
645
+ sources: {
646
+ 'docs-cloud-f5-com': {
647
+ title: 'F5 Distributed Cloud Documentation',
648
+ description: 'Official F5 Distributed Cloud product documentation.',
649
+ },
650
+ 'my-f5-com': {
651
+ title: 'MyF5 Knowledge',
652
+ description: 'F5 support and knowledge articles.',
653
+ },
654
+ },
655
+ }
656
+ : undefined);
620
657
  const mergeIndex = federatedSearch
621
658
  ? federatedSearchSites
622
659
  .filter((s) => `/${s.repo}` !== normalizedBase)
@@ -681,6 +718,7 @@ export function createF5xcDocsConfig(options: F5xcDocsConfigOptions = {}) {
681
718
  demote: llmsConfig.demote || ['references*'],
682
719
  ...(llmsFederatedSites.length > 0 ? { federatedSites: llmsFederatedSites } : {}),
683
720
  ...(llmsFederatedSiteCategories.length > 0 ? { federatedSiteCategories: llmsFederatedSiteCategories } : {}),
721
+ ...(progressiveCorpus ? { progressiveCorpus } : {}),
684
722
  }),
685
723
  ];
686
724
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@f5-sales-demo/docs-theme",
3
- "version": "4.0.17",
3
+ "version": "4.1.0",
4
4
  "description": "F5 Distributed Cloud branded Starlight documentation theme",
5
5
  "type": "module",
6
6
  "engines": {
@@ -139,7 +139,7 @@
139
139
  "@anthropic-ai/sdk": "^0.121.0",
140
140
  "@astrojs/react": "^6.0.4",
141
141
  "@f5-sales-demo/i18n-core": "^1.0.56",
142
- "@f5-sales-demo/starlight-llms-txt": "2.0.0",
142
+ "@f5-sales-demo/starlight-llms-txt": "2.1.0",
143
143
  "@f5-sales-demo/starlight-mega-menu": "^3.0.0",
144
144
  "gray-matter": "^4.0.3",
145
145
  "remark-code-import": "^1.2.0",
@@ -450,6 +450,20 @@ export const itemDescriptions: Record<string, I18nString> = {
450
450
  hi: 'कंटेनरीकृत Astro बिल्ड सिस्टम',
451
451
  th: 'ระบบบิลด์ Astro แบบคอนเทนเนอร์',
452
452
  },
453
+ 'Machine-readable F5 product documentation': {
454
+ fr: 'Documentation produit F5 lisible par machine',
455
+ es: 'Documentación de productos F5 legible por máquinas',
456
+ de: 'Maschinenlesbare F5-Produktdokumentation',
457
+ 'pt-BR': 'Documentação de produtos F5 legível por máquina',
458
+ ja: '機械可読な F5 製品ドキュメント',
459
+ ko: '기계 판독 가능한 F5 제품 문서',
460
+ 'zh-CN': '机器可读的 F5 产品文档',
461
+ 'zh-TW': '機器可讀的 F5 產品文件',
462
+ ar: 'وثائق منتجات F5 القابلة للقراءة آليًا',
463
+ it: 'Documentazione dei prodotti F5 leggibile dalle macchine',
464
+ hi: 'मशीन-पठनीय F5 उत्पाद दस्तावेज़',
465
+ th: 'เอกสารผลิตภัณฑ์ F5 ที่เครื่องอ่านได้',
466
+ },
453
467
  'Shared branding and styling': {
454
468
  fr: 'Image de marque et styles partagés',
455
469
  es: 'Marca y estilos compartidos',
@@ -1094,6 +1108,20 @@ export const itemLabels: Record<string, I18nString> = {
1094
1108
  hi: 'डॉक्स बिल्डर',
1095
1109
  th: 'ตัวสร้างเอกสาร',
1096
1110
  },
1111
+ 'F5 Docs Corpus': {
1112
+ fr: 'Corpus de documentation F5',
1113
+ es: 'Corpus de documentación de F5',
1114
+ de: 'F5-Dokumentationskorpus',
1115
+ 'pt-BR': 'Corpus de documentação da F5',
1116
+ ja: 'F5 ドキュメントコーパス',
1117
+ ko: 'F5 문서 코퍼스',
1118
+ 'zh-CN': 'F5 文档语料库',
1119
+ 'zh-TW': 'F5 文件語料庫',
1120
+ ar: 'مجموعة وثائق F5',
1121
+ it: 'Corpus della documentazione F5',
1122
+ hi: 'F5 दस्तावेज़ कॉर्पस',
1123
+ th: 'คลังเอกสาร F5',
1124
+ },
1097
1125
  'Docs Theme': {
1098
1126
  fr: 'Thème de documentation',
1099
1127
  es: 'Tema de documentación',