Skip to content

Jon/added heap page #360

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Jon/added heap page #360

wants to merge 5 commits into from

Conversation

fern-support
Copy link
Contributor

Added a new page documenting Heap integration

Copy link
Contributor

github-actions bot commented Aug 5, 2025

@fern-support fern-support requested a review from kgowru August 5, 2025 21:21
Updated the information
Copy link
Contributor

github-actions bot commented Aug 5, 2025

@fern-support fern-support requested a review from devalog August 5, 2025 22:00
window.heapReadyCb=window.heapReadyCb||[],window.heap=window.heap||[],heap.load=function(e,t){window.heap.envId=e,window.heap.clientConfig=t=t||{},window.heap.clientConfig.shouldFetchServerConfig=!1;var a=document.createElement("script");a.type="text/javascript",a.async=!0,a.src="https://cdn.us.heap-api.com/config/"+e+"/heap_config.js";var r=document.getElementsByTagName("script")[0];r.parentNode.insertBefore(a,r);var n=["init","startTracking","stopTracking","track","resetIdentity","identify","getSessionId","getUserId","getIdentity","addUserProperties","addEventProperties","removeEventProperty","clearEventProperties","addAccountProperties","addAdapter","addTransformer","addTransformerFn","onReady","addPageviewProperties","removePageviewProperty","clearPageviewProperties","trackPageview"],i=function(e){return function(){var t=Array.prototype.slice.call(arguments,0);window.heapReadyCb.push({name:e,fn:function(){heap[e]&&heap[e].apply(heap,t)}})}};for(var p=0;p<n.length;p++)heap[n[p]]=i(n[p])};

// Initialize Heap with your environment ID
heap.load("YOUR_ENVIRONMENT_ID");
Copy link
Collaborator

Choose a reason for hiding this comment

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

Extreme nit, but the Mixpanel doc uses single quotes for a placeholder text like this ('YOUR_PROJECT_TOKEN'). I actually think the double quotes is more readable but either way probably good to be consistent!

@@ -0,0 +1,63 @@
---
Copy link
Collaborator

Choose a reason for hiding this comment

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

Add a card for this page to the overview? https://buildwithfern.com/learn/docs/integrations/overview

Also, is the part in the overview about adding environment variables to docs.yml relevant to Heap? If so, I would explicitly show that on the Heap page.

Learn how to integrate Fern Docs with Heap to track user behavior and
analytics.
---

Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd suggest adding a brief sentence or two that describes the use case i.e. why someone would want to add Heap to Fern Docs. The description in the frontmatter is a good start (though that's not visible directly on the page), but I'd want the intro to be slightly more specific.

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.

2 participants