diff --git a/.pnp.cjs b/.pnp.cjs
index 2be30335afa..128adf21637 100644
--- a/.pnp.cjs
+++ b/.pnp.cjs
@@ -6687,7 +6687,7 @@ function $$SETUP_STATE(hydrateRuntimeState, basePath) {
"packageDependencies": [\
["@fern-api/configuration", "workspace:packages/cli/configuration"],\
["@fern-api/core-utils", "workspace:packages/commons/core-utils"],\
- ["@fern-api/fdr-sdk", "npm:0.98.18-aaf13f7f5"],\
+ ["@fern-api/fdr-sdk", "npm:0.98.18-ff8e48d2c"],\
["@fern-api/fs-utils", "workspace:packages/commons/fs-utils"],\
["@fern-api/task-context", "workspace:packages/cli/task-context"],\
["@fern-fern/fiddle-sdk", "npm:0.0.584"],\
@@ -6718,7 +6718,7 @@ function $$SETUP_STATE(hydrateRuntimeState, basePath) {
"packageLocation": "./packages/core/",\
"packageDependencies": [\
["@fern-api/core", "workspace:packages/core"],\
- ["@fern-api/fdr-sdk", "npm:0.98.18-aaf13f7f5"],\
+ ["@fern-api/fdr-sdk", "npm:0.98.18-ff8e48d2c"],\
["@fern-api/venus-api-sdk", "npm:0.0.38"],\
["@fern-fern/fdr-test-sdk", "npm:0.0.5297"],\
["@fern-fern/fiddle-sdk", "npm:0.0.584"],\
@@ -6807,7 +6807,7 @@ function $$SETUP_STATE(hydrateRuntimeState, basePath) {
"packageLocation": "./packages/cli/docs-markdown-utils/",\
"packageDependencies": [\
["@fern-api/docs-markdown-utils", "workspace:packages/cli/docs-markdown-utils"],\
- ["@fern-api/fdr-sdk", "npm:0.98.18-aaf13f7f5"],\
+ ["@fern-api/fdr-sdk", "npm:0.98.18-ff8e48d2c"],\
["@fern-api/fs-utils", "workspace:packages/commons/fs-utils"],\
["@fern-api/task-context", "workspace:packages/cli/task-context"],\
["@types/diff", "npm:5.2.1"],\
@@ -6835,7 +6835,7 @@ function $$SETUP_STATE(hydrateRuntimeState, basePath) {
"packageDependencies": [\
["@fern-api/docs-preview", "workspace:packages/cli/docs-preview"],\
["@fern-api/docs-resolver", "workspace:packages/cli/docs-resolver"],\
- ["@fern-api/fdr-sdk", "npm:0.98.18-aaf13f7f5"],\
+ ["@fern-api/fdr-sdk", "npm:0.98.18-ff8e48d2c"],\
["@fern-api/fs-utils", "workspace:packages/commons/fs-utils"],\
["@fern-api/ir-sdk", "workspace:packages/ir-sdk"],\
["@fern-api/logger", "workspace:packages/cli/logger"],\
@@ -6877,7 +6877,7 @@ function $$SETUP_STATE(hydrateRuntimeState, basePath) {
["@fern-api/configuration", "workspace:packages/cli/configuration"],\
["@fern-api/core-utils", "workspace:packages/commons/core-utils"],\
["@fern-api/docs-markdown-utils", "workspace:packages/cli/docs-markdown-utils"],\
- ["@fern-api/fdr-sdk", "npm:0.98.18-aaf13f7f5"],\
+ ["@fern-api/fdr-sdk", "npm:0.98.18-ff8e48d2c"],\
["@fern-api/fs-utils", "workspace:packages/commons/fs-utils"],\
["@fern-api/ir-generator", "workspace:packages/cli/generation/ir-generator"],\
["@fern-api/ir-sdk", "workspace:packages/ir-sdk"],\
@@ -6939,7 +6939,7 @@ function $$SETUP_STATE(hydrateRuntimeState, basePath) {
"packageDependencies": [\
["@fern-api/ete-tests", "workspace:packages/cli/ete-tests"],\
["@fern-api/configuration", "workspace:packages/cli/configuration"],\
- ["@fern-api/fdr-sdk", "npm:0.98.18-aaf13f7f5"],\
+ ["@fern-api/fdr-sdk", "npm:0.98.18-ff8e48d2c"],\
["@fern-api/fs-utils", "workspace:packages/commons/fs-utils"],\
["@fern-api/logging-execa", "workspace:packages/commons/logging-execa"],\
["@fern-typescript/fetcher", "workspace:generators/typescript/utils/core-utilities/fetcher"],\
@@ -6965,10 +6965,10 @@ function $$SETUP_STATE(hydrateRuntimeState, basePath) {
}]\
]],\
["@fern-api/fdr-sdk", [\
- ["npm:0.98.18-aaf13f7f5", {\
- "packageLocation": "./.yarn/cache/@fern-api-fdr-sdk-npm-0.98.18-aaf13f7f5-28d1ceb312-2cab59acf6.zip/node_modules/@fern-api/fdr-sdk/",\
+ ["npm:0.98.18-ff8e48d2c", {\
+ "packageLocation": "./.yarn/cache/@fern-api-fdr-sdk-npm-0.98.18-ff8e48d2c-079b2989be-769cb23e52.zip/node_modules/@fern-api/fdr-sdk/",\
"packageDependencies": [\
- ["@fern-api/fdr-sdk", "npm:0.98.18-aaf13f7f5"],\
+ ["@fern-api/fdr-sdk", "npm:0.98.18-ff8e48d2c"],\
["dayjs", "npm:1.11.11"],\
["fast-deep-equal", "npm:3.1.3"],\
["form-data", "npm:4.0.0"],\
@@ -6978,7 +6978,7 @@ function $$SETUP_STATE(hydrateRuntimeState, basePath) {
["qs", "npm:6.12.0"],\
["tinycolor2", "npm:1.6.0"],\
["title", "npm:3.5.3"],\
- ["ts-essentials", "virtual:28d1ceb312fdf30b3889763086eb43ef1fa907b02f19c69ce6ef14f15fd5dcd8fec7e8749fffde28c437ad670bcaad63cb76004dc0b461741f0ead797d2fa6aa#npm:10.0.1"],\
+ ["ts-essentials", "virtual:079b2989be3894095b065f63883c73db7462e2c23c4186d08738fa1ac1ff7d58a5600e0781e44f82f18f2ddad6a71ba9dc0d5aed76521a27b67d3600fd1b0ae0#npm:10.0.1"],\
["url-join", "npm:5.0.0"]\
],\
"linkType": "HARD"\
@@ -7661,7 +7661,7 @@ function $$SETUP_STATE(hydrateRuntimeState, basePath) {
["@fern-api/configuration", "workspace:packages/cli/configuration"],\
["@fern-api/core", "workspace:packages/core"],\
["@fern-api/core-utils", "workspace:packages/commons/core-utils"],\
- ["@fern-api/fdr-sdk", "npm:0.98.18-aaf13f7f5"],\
+ ["@fern-api/fdr-sdk", "npm:0.98.18-ff8e48d2c"],\
["@fern-api/ir-generator", "workspace:packages/cli/generation/ir-generator"],\
["@fern-api/ir-sdk", "workspace:packages/ir-sdk"],\
["@fern-api/task-context", "workspace:packages/cli/task-context"],\
@@ -7690,7 +7690,7 @@ function $$SETUP_STATE(hydrateRuntimeState, basePath) {
["@fern-api/core", "workspace:packages/core"],\
["@fern-api/core-utils", "workspace:packages/commons/core-utils"],\
["@fern-api/docs-resolver", "workspace:packages/cli/docs-resolver"],\
- ["@fern-api/fdr-sdk", "npm:0.98.18-aaf13f7f5"],\
+ ["@fern-api/fdr-sdk", "npm:0.98.18-ff8e48d2c"],\
["@fern-api/fs-utils", "workspace:packages/commons/fs-utils"],\
["@fern-api/ir-generator", "workspace:packages/cli/generation/ir-generator"],\
["@fern-api/ir-migrations", "workspace:packages/cli/generation/ir-migrations"],\
@@ -29140,10 +29140,10 @@ function $$SETUP_STATE(hydrateRuntimeState, basePath) {
],\
"linkType": "SOFT"\
}],\
- ["virtual:28d1ceb312fdf30b3889763086eb43ef1fa907b02f19c69ce6ef14f15fd5dcd8fec7e8749fffde28c437ad670bcaad63cb76004dc0b461741f0ead797d2fa6aa#npm:10.0.1", {\
- "packageLocation": "./.yarn/__virtual__/ts-essentials-virtual-775a1e0e35/0/cache/ts-essentials-npm-10.0.1-1673b298f7-f70583c154.zip/node_modules/ts-essentials/",\
+ ["virtual:079b2989be3894095b065f63883c73db7462e2c23c4186d08738fa1ac1ff7d58a5600e0781e44f82f18f2ddad6a71ba9dc0d5aed76521a27b67d3600fd1b0ae0#npm:10.0.1", {\
+ "packageLocation": "./.yarn/__virtual__/ts-essentials-virtual-d77c48c18b/0/cache/ts-essentials-npm-10.0.1-1673b298f7-f70583c154.zip/node_modules/ts-essentials/",\
"packageDependencies": [\
- ["ts-essentials", "virtual:28d1ceb312fdf30b3889763086eb43ef1fa907b02f19c69ce6ef14f15fd5dcd8fec7e8749fffde28c437ad670bcaad63cb76004dc0b461741f0ead797d2fa6aa#npm:10.0.1"],\
+ ["ts-essentials", "virtual:079b2989be3894095b065f63883c73db7462e2c23c4186d08738fa1ac1ff7d58a5600e0781e44f82f18f2ddad6a71ba9dc0d5aed76521a27b67d3600fd1b0ae0#npm:10.0.1"],\
["@types/typescript", null],\
["typescript", null]\
],\
diff --git a/.yarn/cache/@fern-api-fdr-sdk-npm-0.98.18-aaf13f7f5-28d1ceb312-2cab59acf6.zip b/.yarn/cache/@fern-api-fdr-sdk-npm-0.98.18-ff8e48d2c-079b2989be-769cb23e52.zip
similarity index 83%
rename from .yarn/cache/@fern-api-fdr-sdk-npm-0.98.18-aaf13f7f5-28d1ceb312-2cab59acf6.zip
rename to .yarn/cache/@fern-api-fdr-sdk-npm-0.98.18-ff8e48d2c-079b2989be-769cb23e52.zip
index c5953a55f34..cee88ca835c 100644
Binary files a/.yarn/cache/@fern-api-fdr-sdk-npm-0.98.18-aaf13f7f5-28d1ceb312-2cab59acf6.zip and b/.yarn/cache/@fern-api-fdr-sdk-npm-0.98.18-ff8e48d2c-079b2989be-769cb23e52.zip differ
diff --git a/fern/docs.yml b/fern/docs.yml
index 701f33fe982..21921c56cfe 100644
--- a/fern/docs.yml
+++ b/fern/docs.yml
@@ -305,6 +305,10 @@ navigation:
- page: ReadMe
slug: readme
path: ./pages/docs/comparison/readme.mdx
+ - section: Analytics
+ contents:
+ - page: Segment
+ path: ./pages/docs/analytics/segment.mdx
- tab: cli-api
layout:
- section: CLI Reference
diff --git a/fern/pages/docs/analytics/segment.mdx b/fern/pages/docs/analytics/segment.mdx
new file mode 100644
index 00000000000..d8e42c49dc3
--- /dev/null
+++ b/fern/pages/docs/analytics/segment.mdx
@@ -0,0 +1,33 @@
+---
+title: Segment
+description: Learn how to integrate Fern Docs with Segment to track user behavior and analytics.
+---
+
+
+Currently we only support Segment via a custom writeKey in the docs.yml file, however you can add other providers to your docs page through [Custom Javascript](/learn/docs/building-your-docs/custom-css-js).
+We are also working on adding support for additional analytics tools via the docs.yml file analytics block!
+
+
+## Add Segment to your Docs
+
+To add Segment to your Docs, you need to add the Segment writeKey to your `docs.yml` file.
+
+### Get your Segment writeKey
+
+1. Log in to your Segment account.
+2. Go to the workspace where you want to add the Docs integration.
+3. Click on the Source you want to track.'
+4. Click on the `Settings` tab.
+5. Copy the `Write Key` from the `API Keys` section.
+
+### Add the Segment writeKey to your Docs
+
+In your `docs.yml` file, add the Segment writeKey:
+
+
+```yaml
+analytics:
+ segment:
+ write-key: YOUR_SEGMENT_WRITE_KEY
+```
+
\ No newline at end of file
diff --git a/packages/cli/configuration/fern/definition/docs.yml b/packages/cli/configuration/fern/definition/docs.yml
index 8aba81e9b05..7a0a50e3d1c 100644
--- a/packages/cli/configuration/fern/definition/docs.yml
+++ b/packages/cli/configuration/fern/definition/docs.yml
@@ -20,6 +20,14 @@ types:
- jvm
- ts
- js
+
+ AnalyticsConfig:
+ properties:
+ segment: optional
+
+ SegmentConfig:
+ properties:
+ write-key: string
DocsConfiguration:
properties:
@@ -27,6 +35,11 @@ types:
title:
type: optional
docs: used as tab bar title, and in the navbar if no logo is defined
+ analytics:
+ type: optional
+ docs: |
+ The `analytics` object allows you to configure analytics for your docs site.
+ Currently, only Segment is supported.
# navigation
tabs: optional