From b886ff03ba3d5dd0da61beeca22a7e87bc0334d0 Mon Sep 17 00:00:00 2001 From: Adeola Adeyemo Date: Fri, 29 May 2026 15:55:43 +0100 Subject: [PATCH 1/2] chore: fix embedding links for journeys Signed-off-by: Adeola Adeyemo --- docs/journeys/embedding.md | 8 ++++---- docs/journeys/sdk.md | 12 ++++++------ docs/journeys/web-components.md | 6 +++--- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/journeys/embedding.md b/docs/journeys/embedding.md index 2291e42..7a4d710 100644 --- a/docs/journeys/embedding.md +++ b/docs/journeys/embedding.md @@ -10,7 +10,7 @@ This guide covers all available embedding options and the `__epilot` JavaScript :::info Legacy embed flow -This page documents the original `__epilot` iframe script. All new integrations should use the [Journey Embed SDK (Beta)](./sdk), which rewrites the iframe engine and adds support for the [``](./web-components) Web Component behind a single API. +This page documents the original `__epilot` iframe script. All new integrations should use the [Journey Embed SDK](/docs/journeys/sdk), which rewrites the iframe engine and adds support for the [``](/docs/journeys/web-components) Web Component behind a single API. Existing embeds continue to work. For new projects, start with the SDK. @@ -344,9 +344,9 @@ In this example, no `data-ep-` attributes are needed because the `__epilot.init( ## Recommended: Journey Embed SDK (Beta) -For new integrations, use the [Journey Embed SDK (Beta)](./sdk). It replaces the legacy `__epilot` script documented on this page with a unified JavaScript API that covers both: +For new integrations, use the [Journey Embed SDK (Beta)](/docs/journeys/sdk). It replaces the legacy `__epilot` script documented on this page with a unified JavaScript API that covers both: - A **rewritten iframe engine** — same embedding model, faster and cleaner than the legacy bundle. -- The [`` Web Component](./web-components) — renders directly in your page using Shadow DOM for better performance, accessibility, and tighter host integration. +- The [`` Web Component](/docs/journeys/web-components) — renders directly in your page using Shadow DOM for better performance, accessibility, and tighter host integration. -See the [SDK documentation](./sdk) for setup, the full API reference, and a migration guide from `__epilot.init()`. +See the [SDK documentation](/docs/journeys/sdk) for setup, the full API reference, and a migration guide from `__epilot.init()`. diff --git a/docs/journeys/sdk.md b/docs/journeys/sdk.md index 1254c53..eb8877f 100644 --- a/docs/journeys/sdk.md +++ b/docs/journeys/sdk.md @@ -2,16 +2,16 @@ sidebar_position: 5 --- -# Journey Embed SDK (Beta) +# Journey Embed SDK The Journey Embed SDK is a chainable JavaScript API for rendering epilot Journeys. One SDK, two backends: -- A **rewritten iframe engine** that replaces the legacy [`__epilot` script](./embedding) with a faster, cleaner host integration. -- The [`` Web Component](./web-components), a custom HTML element that renders in Shadow DOM. +- A **rewritten iframe engine** that replaces the legacy [`__epilot` script](/docs/journeys/embedding) with a faster, cleaner host integration. +- The [`` Web Component](/docs/journeys/web-components), a custom HTML element that renders in Shadow DOM. :::info Beta -The SDK is in beta. Test it before rolling out to production. Existing embeds using the [legacy `__epilot` script](./embedding) continue to work. +The SDK is in beta. Test it before rolling out to production. Existing embeds using the [legacy `__epilot` script](/docs/journeys/embedding) continue to work. ::: @@ -19,7 +19,7 @@ The SDK is in beta. Test it before rolling out to production. Existing embeds us For iframe embedding, the SDK is the new default. It replaces the legacy `__epilot` script. -For web components, use the SDK or drop the [``](./web-components) element directly into your HTML, whichever fits your integration. +For web components, use the SDK or drop the [``](/docs/journeys/web-components) element directly into your HTML, whichever fits your integration. ::: @@ -698,7 +698,7 @@ When you embed with `.asIframe()`, `.contextData()` values are forwarded to the ## Content-Security-Policy (CSP) -The SDK uses the same script origin as the Web Component embed. See the [Web Components CSP guide](./web-components#content-security-policy-csp) for the required policy directives. +The SDK uses the same script origin as the Web Component embed. See the [Web Components CSP guide](/docs/journeys/web-components#content-security-policy-csp) for the required policy directives. ## Migrating from the Legacy `__epilot` API diff --git a/docs/journeys/web-components.md b/docs/journeys/web-components.md index b763ece..cadcb5b 100644 --- a/docs/journeys/web-components.md +++ b/docs/journeys/web-components.md @@ -82,7 +82,7 @@ All attributes are set as standard HTML attributes on the `` ele :::tip Accessible name -The standard HTML `title` attribute works on `` and is exposed to screen readers. If you embed via the [Journey Embed SDK](./sdk), use `.name(value)` — it sets `title` on the element for you. +The standard HTML `title` attribute works on `` and is exposed to screen readers. If you embed via the [Journey Embed SDK](/docs/journeys/sdk), use `.name(value)` — it sets `title` on the element for you. ::: @@ -270,7 +270,7 @@ document.querySelector('epilot-journey').refresh() ## Events -The `` Web Component dispatches custom events on the `window` object that you can listen for. The event names are the same as the iframe `postMessage` events used by the [iframe embed script](./embedding), so you can use the same event names regardless of the embedding method. +The `` Web Component dispatches custom events on the `window` object that you can listen for. The event names are the same as the iframe `postMessage` events used by the [iframe embed script](/docs/journeys/embedding), so you can use the same event names regardless of the embedding method. ### Event Reference @@ -371,7 +371,7 @@ To load a different Journey, update the attributes on the existing element rathe ``` -If you need multiple Journeys visible simultaneously, use the [iframe embedding](./embedding) approach instead. +If you need multiple Journeys visible simultaneously, use the [iframe embedding](/docs/journeys/embedding) approach instead. ## Content-Security-Policy (CSP) From 4274bdbe716adaebdc37de91f7b89a8765b60809 Mon Sep 17 00:00:00 2001 From: Adeola Adeyemo Date: Fri, 29 May 2026 15:56:51 +0100 Subject: [PATCH 2/2] chore: update text Signed-off-by: Adeola Adeyemo --- docs/journeys/embedding.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/journeys/embedding.md b/docs/journeys/embedding.md index 7a4d710..d1bdea2 100644 --- a/docs/journeys/embedding.md +++ b/docs/journeys/embedding.md @@ -342,9 +342,9 @@ In this example, no `data-ep-` attributes are needed because the `__epilot.init( **Outcome** ![Embedding Multiple Outcome](../../static/img/journey-embed-outcome-multiple.gif) -## Recommended: Journey Embed SDK (Beta) +## Recommended: Journey Embed SDK -For new integrations, use the [Journey Embed SDK (Beta)](/docs/journeys/sdk). It replaces the legacy `__epilot` script documented on this page with a unified JavaScript API that covers both: +For new integrations, use the [Journey Embed SDK](/docs/journeys/sdk). It replaces the legacy `__epilot` script documented on this page with a unified JavaScript API that covers both: - A **rewritten iframe engine** — same embedding model, faster and cleaner than the legacy bundle. - The [`` Web Component](/docs/journeys/web-components) — renders directly in your page using Shadow DOM for better performance, accessibility, and tighter host integration.