-
Notifications
You must be signed in to change notification settings - Fork 2
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
base: main
Are you sure you want to change the base?
Jon/added heap page #360
Conversation
I mimicked the page for Mixpanel
Added to the wrong location
Updated the information
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"); |
There was a problem hiding this comment.
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 @@ | |||
--- |
There was a problem hiding this comment.
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. | ||
--- | ||
|
There was a problem hiding this comment.
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.
Added a new page documenting Heap integration