From 518c2b33e1b764060ac482d3108ff31bc230cb5a Mon Sep 17 00:00:00 2001
From: michaelKurowski <mkurowski@vuestorefront.io>
Date: Tue, 22 Apr 2025 15:53:34 +0200
Subject: [PATCH 1/6] docs: draft for page router

---
 docs/content/guides/8.instrumentation.md | 65 ++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 docs/content/guides/8.instrumentation.md

diff --git a/docs/content/guides/8.instrumentation.md b/docs/content/guides/8.instrumentation.md
new file mode 100644
index 0000000000..ffb22e6f1f
--- /dev/null
+++ b/docs/content/guides/8.instrumentation.md
@@ -0,0 +1,65 @@
+In case if you are extending your contract with Alokai and you have joined us in 2025 or before, you may be required to install Alokai instrumentation as part of your storefront.
+
+Here is a guide on how to do this, depending on your current situation.
+
+# Storefront
+::tabs{:titles='["Next.js App Router", "Nuxt 3", "Next.js Page Router", "Nuxt 2"]'}
+
+#tab-1
+If you use `@vue-storefront/next` newer or equal to `6.1.0`, then no action is required.
+
+#tab-2
+If you use `@vue-storefront/nuxt` newer or equal to `0.2.1`, then no action is required.
+
+#tab-3
+Go to `pages/_app.tsx
+
+
+```diff
+import { getHistoryTraceScript } from '@alokai/instrumentation/client';
+
+...
+  return (
+    
+    <SdkProvider>
++       <Script dangerouslySetInnerHTML={{ __html: getHistoryTraceScript() }} />
+    ...
+  </SdkProvider>
+)
+```
+
+#tab-4
+
+
+# Middleware
+If you use `@alokai/connect` newer or equal to `1.1.0`, then no action is required.
+Otherwise install the package `@todo/todo` 
+
+
+```diff
++ import { installTraceServer } from '@vsf-enterprise/trace/server'
+
+
+export const config = {
+  location: 'name-of-your-integration-package',
+  configuration: {
+    ...
+  },
+
+  extensions: (extensions: ApiClientExtension[]) => [
+    ...extensions,
++   {
++     name: 'trace',
++     extendApp({ app }) {
++       installTraceServer(app);
++     },
++   },
+    unifiedApiExtension,
+    cdnExtension,
+    configSwitcherExtension,
+  ],
+} satisfies Integration<Config>;
+```
+
+# Verifying that it works
+To verify that all works as intended, please contact our support.
\ No newline at end of file

From e6b74b8fdab086bec5045e75636153b61c8fe973 Mon Sep 17 00:00:00 2001
From: michaelKurowski <mkurowski@vuestorefront.io>
Date: Tue, 29 Apr 2025 22:16:13 +0200
Subject: [PATCH 2/6] docs: added missing docs

---
 docs/content/guides/8.instrumentation.md | 29 ++++++++++++++----------
 1 file changed, 17 insertions(+), 12 deletions(-)

diff --git a/docs/content/guides/8.instrumentation.md b/docs/content/guides/8.instrumentation.md
index ffb22e6f1f..3d6880d397 100644
--- a/docs/content/guides/8.instrumentation.md
+++ b/docs/content/guides/8.instrumentation.md
@@ -12,17 +12,16 @@ If you use `@vue-storefront/next` newer or equal to `6.1.0`, then no action is r
 If you use `@vue-storefront/nuxt` newer or equal to `0.2.1`, then no action is required.
 
 #tab-3
-Go to `pages/_app.tsx
-
+Go to `pages/_app.tsx and add AlokaiInstrumentation component inside the SdkProvider.
 
 ```diff
-import { getHistoryTraceScript } from '@alokai/instrumentation/client';
+import { AlokaiInstrumentation } from '@alokai/instrumentation-next-component';
 
 ...
   return (
     
     <SdkProvider>
-+       <Script dangerouslySetInnerHTML={{ __html: getHistoryTraceScript() }} />
++       <AlokaiInstrumentation />
     ...
   </SdkProvider>
 )
@@ -30,14 +29,25 @@ import { getHistoryTraceScript } from '@alokai/instrumentation/client';
 
 #tab-4
 
+In your `nuxt.config.js` add the following to the `buildModules` array:
+
+```diff 
+  buildModules: [
+    '@nuxtjs/composition-api/module',
+    '@nuxt/typescript-build',
+    '@nuxtjs/style-resources',
+    '@nuxtjs/pwa',
++   '@alokai/instrumentation-nuxt2-module',
+```
+
 
 # Middleware
 If you use `@alokai/connect` newer or equal to `1.1.0`, then no action is required.
-Otherwise install the package `@todo/todo` 
+Otherwise install the package `@alokai/instrumentation` and add the `traceExtension` to the extensions array of your e-commerce integration.
 
 
 ```diff
-+ import { installTraceServer } from '@vsf-enterprise/trace/server'
++ import { traceExtension } from '@alokai/instrumentation'
 
 
 export const config = {
@@ -48,12 +58,7 @@ export const config = {
 
   extensions: (extensions: ApiClientExtension[]) => [
     ...extensions,
-+   {
-+     name: 'trace',
-+     extendApp({ app }) {
-+       installTraceServer(app);
-+     },
-+   },
++   traceExtension,
     unifiedApiExtension,
     cdnExtension,
     configSwitcherExtension,

From 90049570974c654375775830e6c62ac4b5af9f2c Mon Sep 17 00:00:00 2001
From: michaelKurowski <mkurowski@vuestorefront.io>
Date: Tue, 29 Apr 2025 23:36:24 +0200
Subject: [PATCH 3/6] docs: proofread

---
 docs/content/guides/8.instrumentation.md | 19 ++++++++++---------
 1 file changed, 10 insertions(+), 9 deletions(-)

diff --git a/docs/content/guides/8.instrumentation.md b/docs/content/guides/8.instrumentation.md
index 3d6880d397..d17170448a 100644
--- a/docs/content/guides/8.instrumentation.md
+++ b/docs/content/guides/8.instrumentation.md
@@ -1,18 +1,18 @@
-In case if you are extending your contract with Alokai and you have joined us in 2025 or before, you may be required to install Alokai instrumentation as part of your storefront.
+If you are extending your contract with Alokai and joined us in 2025 or earlier, you may be required to install Alokai instrumentation as part of your storefront setup.
 
-Here is a guide on how to do this, depending on your current situation.
+Please refer to the appropriate section below based on your current setup:
 
 # Storefront
 ::tabs{:titles='["Next.js App Router", "Nuxt 3", "Next.js Page Router", "Nuxt 2"]'}
 
 #tab-1
-If you use `@vue-storefront/next` newer or equal to `6.1.0`, then no action is required.
+If you are using `@vue-storefront/next` version `6.1.0` or later, no action is required.
 
 #tab-2
-If you use `@vue-storefront/nuxt` newer or equal to `0.2.1`, then no action is required.
+If you are using `@vue-storefront/nuxt` version `9.1.0` or later, no action is required.
 
 #tab-3
-Go to `pages/_app.tsx and add AlokaiInstrumentation component inside the SdkProvider.
+Go to `pages/_app.tsx` and add `AlokaiInstrumentation` component inside the `SdkProvider`.
 
 ```diff
 import { AlokaiInstrumentation } from '@alokai/instrumentation-next-component';
@@ -29,7 +29,7 @@ import { AlokaiInstrumentation } from '@alokai/instrumentation-next-component';
 
 #tab-4
 
-In your `nuxt.config.js` add the following to the `buildModules` array:
+In your `nuxt.config.js` add the following entry to the `buildModules` array:
 
 ```diff 
   buildModules: [
@@ -42,8 +42,8 @@ In your `nuxt.config.js` add the following to the `buildModules` array:
 
 
 # Middleware
-If you use `@alokai/connect` newer or equal to `1.1.0`, then no action is required.
-Otherwise install the package `@alokai/instrumentation` and add the `traceExtension` to the extensions array of your e-commerce integration.
+If you are using `@alokai/connect` version `1.1.0`, or newer, no action is required.
+For older versions, install the `@alokai/instrumentation` package and add the `traceExtension` to the `extensions` array of your e-commerce integration:
 
 
 ```diff
@@ -67,4 +67,5 @@ export const config = {
 ```
 
 # Verifying that it works
-To verify that all works as intended, please contact our support.
\ No newline at end of file
+To verify that everything is working as intended, please contact our support team.
+

From b01170c6d58ee6fbd4ce06125a485a65b7d786ac Mon Sep 17 00:00:00 2001
From: michaelKurowski <mkurowski@vuestorefront.io>
Date: Wed, 30 Apr 2025 13:17:19 +0200
Subject: [PATCH 4/6] docs: instructions for older versions of next and nuxt
 packages

---
 docs/content/guides/8.instrumentation.md | 37 ++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/docs/content/guides/8.instrumentation.md b/docs/content/guides/8.instrumentation.md
index d17170448a..11d0c96dd9 100644
--- a/docs/content/guides/8.instrumentation.md
+++ b/docs/content/guides/8.instrumentation.md
@@ -8,9 +8,46 @@ Please refer to the appropriate section below based on your current setup:
 #tab-1
 If you are using `@vue-storefront/next` version `6.1.0` or later, no action is required.
 
+Otherwise update the said package to the required version, or please install the `@alokai/instrumentation-next-component` package and add it to your main layout file:
+
+```diff
+  import { AlokaiInstrumentation } from '@alokai/instrumentation-next-component';
+  ...
+  return (
+    <html lang={locale}>
+      <head>
+        <link href="res.cloudinary.com" rel="preconnect" />
+      </head>
+      <body className={classNames(fontHeadings.variable, fontBody.variable, 'font-body')}>
+        <NextIntlClientProvider messages={pick(messages, 'Notifications.NotificationAlert')}>
+          <PublicEnvProvider>
+            <Providers initialCurrency={currencies} sdkOptions={sdkConfig}>
++              <AlokaiInstrumentation />
+              {children}
+            </Providers>
+          </PublicEnvProvider>
+        </NextIntlClientProvider>
+      </body>
+    </html>
+  );
+```
+
 #tab-2
 If you are using `@vue-storefront/nuxt` version `9.1.0` or later, no action is required.
 
+Otherwise update the said package to the required version, or please install the `@alokai/instrumentation-nuxt3-module` package and add it to `modules` array in your `nuxt.config.ts`:
+
+```diff
+  modules: [
+    ...
+    '@vue-storefront/nuxt',
+    '@storefront-ui/nuxt',
+    'nuxt-jsonld',
+    '@nuxt/eslint',
++    '@alokai/instrumentation-nuxt3-module',
+  ],
+```
+
 #tab-3
 Go to `pages/_app.tsx` and add `AlokaiInstrumentation` component inside the `SdkProvider`.
 

From 9a7edaaa2d6f5a73a0639ec673792a58166096bd Mon Sep 17 00:00:00 2001
From: michaelKurowski <mkurowski@vuestorefront.io>
Date: Wed, 30 Apr 2025 13:22:13 +0200
Subject: [PATCH 5/6] docs: clarified on migration path

---
 docs/content/guides/8.instrumentation.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/docs/content/guides/8.instrumentation.md b/docs/content/guides/8.instrumentation.md
index 11d0c96dd9..503db1a41c 100644
--- a/docs/content/guides/8.instrumentation.md
+++ b/docs/content/guides/8.instrumentation.md
@@ -1,5 +1,6 @@
 If you are extending your contract with Alokai and joined us in 2025 or earlier, you may be required to install Alokai instrumentation as part of your storefront setup.
 
+The instrumentation has to be enabled for storefront and middleware separately.
 Please refer to the appropriate section below based on your current setup:
 
 # Storefront

From 9394bcbb474b514233f68c3cd2ed7950eff83d8f Mon Sep 17 00:00:00 2001
From: michaelKurowski <mkurowski@vuestorefront.io>
Date: Wed, 30 Apr 2025 13:22:28 +0200
Subject: [PATCH 6/6] docs: clarified on migration path

---
 docs/content/guides/8.instrumentation.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/content/guides/8.instrumentation.md b/docs/content/guides/8.instrumentation.md
index 503db1a41c..2ecfcaf648 100644
--- a/docs/content/guides/8.instrumentation.md
+++ b/docs/content/guides/8.instrumentation.md
@@ -81,7 +81,7 @@ In your `nuxt.config.js` add the following entry to the `buildModules` array:
 
 # Middleware
 If you are using `@alokai/connect` version `1.1.0`, or newer, no action is required.
-For older versions, install the `@alokai/instrumentation` package and add the `traceExtension` to the `extensions` array of your e-commerce integration:
+For older versions, either upgrade the said package to the required version, or install the `@alokai/instrumentation` package and add the `traceExtension` to the `extensions` array of your e-commerce integration:
 
 
 ```diff