From db66f920eef5c3d0d64846f53ec64c2bfa6de3e7 Mon Sep 17 00:00:00 2001 From: lindsayzhng Date: Mon, 27 Jul 2026 14:08:40 -0700 Subject: [PATCH] document cookie consent options --- docs.json | 1 + integrations/privacy/overview.mdx | 74 ++++++++++++++++++++++++------ integrations/privacy/transcend.mdx | 56 ++++++++++++++++++++++ 3 files changed, 118 insertions(+), 13 deletions(-) create mode 100644 integrations/privacy/transcend.mdx diff --git a/docs.json b/docs.json index cc2689cbfb..93c36ad613 100644 --- a/docs.json +++ b/docs.json @@ -293,6 +293,7 @@ "group": "Privacy", "root": "integrations/privacy/overview", "pages": [ + "integrations/privacy/transcend", "integrations/privacy/osano" ] } diff --git a/integrations/privacy/overview.mdx b/integrations/privacy/overview.mdx index 0f9af7d9eb..e1724d1761 100644 --- a/integrations/privacy/overview.mdx +++ b/integrations/privacy/overview.mdx @@ -1,43 +1,91 @@ --- -title: "Privacy integrations" -description: "Connect your Mintlify documentation site to privacy platforms like Osano to manage cookie consent, compliance banners, and user preferences." +title: "Privacy and cookie consent" +description: "Show Mintlify's native consent banner or connect a consent management platform to control analytics on your documentation site." keywords: ["data privacy platforms", "compliance integrations", "privacy tools", "cookie consent"] --- - + The native banner does not send consent decisions to a centralized dashboard or create an audit + log. + + +## Connect a consent manager + +Use a consent manager when your organization needs its own policy configuration, cross-domain consent, reporting, or consent records. + +Your organization configures and maintains its account with the consent manager. A configured +Transcend or OneTrust integration takes precedence over Mintlify's native banner so that visitors +see one consent experience. If you load Osano with a custom script, turn off the native banner. + + + + Connect a Transcend Consent Management bundle and use its Analytics purpose to control tracking. + + } - horizontal + icon={ + + + + } > - Manage cookie consent with [Osano](https://www.osano.com/). - + Add an Osano consent manager with a custom script. + + -## Cookie consent and disabling telemetry +## Use an existing local storage consent signal -If you need to check if a user has already consented to cookies for GDPR compliance, you can specify a local storage key and value under `cookies`: +If another consent tool stores a visitor's choice in local storage, specify its key and accepted value under `cookies`: ```json +{ "integrations": { "cookies": { - "key": "LOCAL STORAGE KEY", - "value": "LOCAL STORAGE VALUE" + "key": "LOCAL_STORAGE_KEY", + "value": "LOCAL_STORAGE_VALUE" } } +} ``` -If you set these values, your site checks local storage for the specified key and value to determine if a user consented to cookies. If a user has not consented to cookies, your site disables telemetry for that user. +Your site disables analytics until the local storage value matches. + +## Disable telemetry If you'd like to disable telemetry for all users, add the following to your `docs.json` file: ```json +{ "integrations": { "telemetry": { "enabled": false } } +} ``` - If you disable telemetry, you cannot collect feedback on your documentation pages, even if you enable feedback in your dashboard. + If you disable telemetry, you cannot collect feedback on your documentation pages, even if you + enable feedback in your dashboard. diff --git a/integrations/privacy/transcend.mdx b/integrations/privacy/transcend.mdx new file mode 100644 index 0000000000..1ac4d4799b --- /dev/null +++ b/integrations/privacy/transcend.mdx @@ -0,0 +1,56 @@ +--- +title: "Transcend" +description: "Connect Transcend Consent Management to your Mintlify documentation site and prevent analytics from loading without consent." +keywords: + ["Transcend integration", "cookie consent manager", "analytics consent", "GDPR compliance"] +--- + +Connect a [Transcend Consent Management](https://transcend.io/consent-management) bundle in your `docs.json` file. + +## Before you begin + +In Transcend, configure your documentation domains and deploy the consent manager bundle. Note the bundle ID from **Consent Management** → **Developer Settings**. + +Your bundle must include the purpose that should control analytics. The default purpose name in Mintlify is `Analytics`. + +## Configure Transcend + +Add your bundle ID under `integrations.transcend`: + +```json +{ + "integrations": { + "transcend": { + "bundleId": "YOUR_BUNDLE_ID" + } + } +} +``` + +Mintlify uses the `Analytics` purpose by default. If your bundle uses a different purpose name, +specify its exact, case-sensitive name: + +```json +{ + "integrations": { + "transcend": { + "bundleId": "YOUR_BUNDLE_ID", + "analyticsPurpose": "Performance" + } + } +} +``` + +Mintlify loads Transcend's `airgap.js` before other scripts and prompts visitors with the consent interface. Mintlify analytics, configured analytics integrations, and page feedback remain disabled while consent is unresolved or the configured purpose is denied. + + + If the configured purpose name doesn't match a purpose in your Transcend bundle, Mintlify treats + analytics consent as denied. + + +Consent reporting, audit history, legal regimes, and policy configuration remain in your Transcend account. Mintlify does not copy individual consent decisions into the Mintlify dashboard. + +When Transcend is configured, it takes precedence over Mintlify's native consent banner so visitors +see only one consent experience. To switch back to the native banner, remove +`integrations.transcend` and enable **Show Mintlify consent banner** under **Settings** → **Privacy** +in the Mintlify dashboard.