Skip to content

docs: add analytics events reference page#5512

Open
devin-ai-integration[bot] wants to merge 2 commits into
mainfrom
devin/1778793395-analytics-events-reference
Open

docs: add analytics events reference page#5512
devin-ai-integration[bot] wants to merge 2 commits into
mainfrom
devin/1778793395-analytics-events-reference

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

Summary

Adds a new "Analytics events reference" page to the Analytics & Integrations section that documents the analytics events Fern emits on customer docs sites. This was prompted by an internal question about whether a comprehensive list of Fern's analytics events exists anywhere — it didn't, so this PR adds one.

New page (fern/products/docs/pages/integrations/analytics/analytics-events.mdx):

  • Page views ($pageview, $pageleave)
  • Feedback events (feedback_voted, feedback_submitted, code_block_feedback_*)
  • API Playground events (api_playground_request_sent, api_playground_request_received)
  • Search/AI events (ask_ai_suggest)
  • Error events (not_found)
  • How to disable analytics
  • Note about CLI and Dashboard telemetry (internal, not forwarded to customers)

Navigation: Added to the "Analytics & integrations" section in docs.yml at slug analytics/events.

Cross-references: Added links to the new page from:

  • The integrations overview page
  • The PostHog integration page

Review & Testing Checklist for Human

  • Verify the new page renders correctly at /learn/docs/integrations/analytics/events
  • Confirm the cross-reference links from the integrations overview and PostHog pages work
  • Review event names and descriptions for accuracy — these were sourced from the fern-platform codebase (packages/fern-docs/bundle/src/components/analytics/)

Notes

  • This page focuses on docs-site events (the ones customers can see in their PostHog). CLI and dashboard events are mentioned but not listed in detail since they're internal telemetry.
  • The comprehensive internal inventory (covering all ~100+ events across dashboard, docs, CLI, and FAI) is available separately if needed for an internal reference.

Link to Devin session: https://app.devin.ai/sessions/3a3123340b924ecc9c7974527db40913

Co-Authored-By: will.kendall@buildwithfern.com <wpk235@gmail.com>
@devin-ai-integration devin-ai-integration Bot requested a review from devalog as a code owner May 14, 2026 21:18
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

| `code_block_feedback_opened` | User opened the feedback prompt on a code block. | Code block context |
| `code_block_feedback_submitted` | User submitted feedback on a code block. | Code block context |

## API Playground events
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'API Playground events' should use sentence-style capitalization.


This disables all analytics integrations configured in the `analytics` section of `docs.yml`, including Google Analytics 4, Google Tag Manager, PostHog, and any other providers.

## CLI and Dashboard events
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'CLI and Dashboard events' should use sentence-style capitalization.


## CLI and Dashboard events

The Fern CLI and [Dashboard](https://dashboard.buildwithfern.com) emit their own analytics events for internal product telemetry (command usage, onboarding funnels, billing events, etc.). These are not forwarded to your analytics providers and are used only by Fern for product improvement.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'aren't' instead of 'are not'.

@github-actions
Copy link
Copy Markdown
Contributor

Co-Authored-By: will.kendall@buildwithfern.com <wpk235@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants