chore: add inkeep search and ai to docs (#10119)

docs/docusaurus.config.js

@@ -174,20 +174,25 @@ module.exports = {
             {
               label: "Status",
               href: "https://status.zitadel.com/",
-            }
+            },
           ],
         },
       ],
       copyright: `Copyright © ${new Date().getFullYear()} ZITADEL Docs - Built with Docusaurus.`,
     },
-    algolia: {
-      appId: "8H6ZKXENLO",
-      apiKey: "124fe1c102a184bc6fc70c75dc84f96f",
-      indexName: "zitadel",
-      selector: "div#",
-    },
     prism: {
-      additionalLanguages: ["csharp", "dart", "groovy", "regex", "java", "php", "python", "protobuf", "json", "bash"],
+      additionalLanguages: [
+        "csharp",
+        "dart",
+        "groovy",
+        "regex",
+        "java",
+        "php",
+        "python",
+        "protobuf",
+        "json",
+        "bash",
+      ],
     },
     colorMode: {
       defaultMode: "dark",
@@ -196,9 +201,9 @@ module.exports = {
     },
     codeblock: {
       showGithubLink: true,
-      githubLinkLabel: 'View on GitHub',
+      githubLinkLabel: "View on GitHub",
       showRunmeLink: false,
-      runmeLinkLabel: 'Checkout via Runme'
+      runmeLinkLabel: "Checkout via Runme",
     },
   },
   presets: [
@@ -214,18 +219,32 @@ module.exports = {
           editUrl: "https://github.com/zitadel/zitadel/edit/main/docs/",
           remarkPlugins: [require("mdx-mermaid")],
 
-          docItemComponent:  '@theme/ApiItem'
+          docItemComponent: "@theme/ApiItem",
         },
         theme: {
           customCss: require.resolve("./src/css/custom.css"),
         },
-      })
+      }),
     ],
-
   ],
   plugins: [
     [
-      'docusaurus-plugin-openapi-docs',
+      "@inkeep/cxkit-docusaurus",
+      {
+        SearchBar: {
+          baseSettings: {
+            apiKey: process.env.INKEEP_API_KEY,
+            primaryBrandColor: "#ff2069",
+            organizationDisplayName: "ZITADEL",
+          },
+        },
+        SearchSettings: {
+          tabs: ["All", "Docs", "GitHub", "Forums", "Discord"],
+        },
+      },
+    ],
+    [
+      "docusaurus-plugin-openapi-docs",
       {
         id: "apiDocs",
         docsPluginId: "classic",
@@ -263,7 +282,8 @@ module.exports = {
             },
           },
           user_v2: {
-            specPath: ".artifacts/openapi/zitadel/user/v2/user_service.swagger.json",
+            specPath:
+              ".artifacts/openapi/zitadel/user/v2/user_service.swagger.json",
             outputDir: "docs/apis/resources/user_service_v2",
             sidebarOptions: {
               groupPathsBy: "tag",
@@ -271,7 +291,8 @@ module.exports = {
             },
           },
           session_v2: {
-            specPath: ".artifacts/openapi/zitadel/session/v2/session_service.swagger.json",
+            specPath:
+              ".artifacts/openapi/zitadel/session/v2/session_service.swagger.json",
             outputDir: "docs/apis/resources/session_service_v2",
             sidebarOptions: {
               groupPathsBy: "tag",
@@ -279,7 +300,8 @@ module.exports = {
             },
           },
           oidc_v2: {
-            specPath: ".artifacts/openapi/zitadel/oidc/v2/oidc_service.swagger.json",
+            specPath:
+              ".artifacts/openapi/zitadel/oidc/v2/oidc_service.swagger.json",
             outputDir: "docs/apis/resources/oidc_service_v2",
             sidebarOptions: {
               groupPathsBy: "tag",
@@ -287,7 +309,8 @@ module.exports = {
             },
           },
           saml_v2: {
-            specPath: ".artifacts/openapi/zitadel/saml/v2/saml_service.swagger.json",
+            specPath:
+              ".artifacts/openapi/zitadel/saml/v2/saml_service.swagger.json",
             outputDir: "docs/apis/resources/saml_service_v2",
             sidebarOptions: {
               groupPathsBy: "tag",
@@ -295,7 +318,8 @@ module.exports = {
             },
           },
           settings_v2: {
-            specPath: ".artifacts/openapi/zitadel/settings/v2/settings_service.swagger.json",
+            specPath:
+              ".artifacts/openapi/zitadel/settings/v2/settings_service.swagger.json",
             outputDir: "docs/apis/resources/settings_service_v2",
             sidebarOptions: {
               groupPathsBy: "tag",
@@ -303,7 +327,8 @@ module.exports = {
             },
           },
           action_v2: {
-            specPath: ".artifacts/openapi/zitadel/action/v2beta/action_service.swagger.json",
+            specPath:
+              ".artifacts/openapi/zitadel/action/v2beta/action_service.swagger.json",
             outputDir: "docs/apis/resources/action_service_v2",
             sidebarOptions: {
               groupPathsBy: "tag",
@@ -311,7 +336,8 @@ module.exports = {
             },
           },
           webkey_v2: {
-            specPath: ".artifacts/openapi/zitadel/webkey/v2beta/webkey_service.swagger.json",
+            specPath:
+              ".artifacts/openapi/zitadel/webkey/v2beta/webkey_service.swagger.json",
             outputDir: "docs/apis/resources/webkey_service_v2",
             sidebarOptions: {
               groupPathsBy: "tag",
@@ -319,7 +345,8 @@ module.exports = {
             },
           },
           feature_v2: {
-            specPath: ".artifacts/openapi/zitadel/feature/v2/feature_service.swagger.json",
+            specPath:
+              ".artifacts/openapi/zitadel/feature/v2/feature_service.swagger.json",
             outputDir: "docs/apis/resources/feature_service_v2",
             sidebarOptions: {
               groupPathsBy: "tag",
@@ -327,7 +354,8 @@ module.exports = {
             },
           },
           org_v2: {
-            specPath: ".artifacts/openapi/zitadel/org/v2/org_service.swagger.json",
+            specPath:
+              ".artifacts/openapi/zitadel/org/v2/org_service.swagger.json",
             outputDir: "docs/apis/resources/org_service_v2",
             sidebarOptions: {
               groupPathsBy: "tag",
@@ -335,7 +363,8 @@ module.exports = {
             },
           },
           idp_v2: {
-            specPath: ".artifacts/openapi/zitadel/idp/v2/idp_service.swagger.json",
+            specPath:
+              ".artifacts/openapi/zitadel/idp/v2/idp_service.swagger.json",
             outputDir: "docs/apis/resources/idp_service_v2",
             sidebarOptions: {
               groupPathsBy: "tag",
@@ -343,7 +372,8 @@ module.exports = {
             },
           },
           org_v2beta: {
-            specPath: ".artifacts/openapi/zitadel/org/v2beta/org_service.swagger.json",
+            specPath:
+              ".artifacts/openapi/zitadel/org/v2beta/org_service.swagger.json",
             outputDir: "docs/apis/resources/org_service_v2beta",
             sidebarOptions: {
               groupPathsBy: "tag",
@@ -351,7 +381,8 @@ module.exports = {
             },
           },
           project_v2beta: {
-            specPath: ".artifacts/openapi/zitadel/project/v2beta/project_service.swagger.json",
+            specPath:
+              ".artifacts/openapi/zitadel/project/v2beta/project_service.swagger.json",
             outputDir: "docs/apis/resources/project_service_v2",
             sidebarOptions: {
               groupPathsBy: "tag",
@@ -359,7 +390,8 @@ module.exports = {
             },
           },
           instance_v2: {
-            specPath: ".artifacts/openapi/zitadel/instance/v2beta/instance_service.swagger.json",
+            specPath:
+              ".artifacts/openapi/zitadel/instance/v2beta/instance_service.swagger.json",
             outputDir: "docs/apis/resources/instance_service_v2",
             sidebarOptions: {
               groupPathsBy: "tag",
@@ -382,13 +414,16 @@ module.exports = {
       };
     },
   ],
-  themes: [ "docusaurus-theme-github-codeblock", "docusaurus-theme-openapi-docs"],
+  themes: [
+    "docusaurus-theme-github-codeblock",
+    "docusaurus-theme-openapi-docs",
+  ],
   future: {
     v4: false, // Disabled because of some problems related to https://github.com/facebook/docusaurus/issues/11040
     experimental_faster: {
       swcJsLoader: false, // Disabled because of memory usage > 8GB which is a problem on vercel default runners
       swcJsMinimizer: true,
-      swcHtmlMinimizer : true,
+      swcHtmlMinimizer: true,
       lightningCssMinimizer: true,
       mdxCrossCompilerCache: true,
       ssgWorkerThreads: false, // Disabled because of some problems related to https://github.com/facebook/docusaurus/issues/11040

docs/package.json

@@ -29,6 +29,7 @@
     "@docusaurus/theme-search-algolia": "^3.8.1",
     "@headlessui/react": "^1.7.4",
     "@heroicons/react": "^2.0.13",
+    "@inkeep/cxkit-docusaurus": "^0.5.89",
     "autoprefixer": "^10.4.13",
     "clsx": "^1.2.1",
     "docusaurus-plugin-image-zoom": "^3.0.1",