-
Notifications
You must be signed in to change notification settings - Fork 7
Add feedback button, interaction tracking, and heatmaps to docs site #624
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
Conversation
- Enabled surveys for CSAT feedback collection - Enabled heatmaps for click and scroll tracking - Added detailed setup documentation for both features - Server tested and running successfully Features now active: ✅ Surveys - For CSAT feedback on every page ✅ Heatmaps - For visualizing user interactions ✅ Page tracking - Automatic pageview events ✅ Custom events - Existing event tracking Next steps: 1. Log into PostHog dashboard (https://us.posthog.com) 2. Create CSAT survey following the guide 3. Review heatmaps to understand user behavior 4. Correlate CSAT scores with interaction patterns 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
- Enable surveys (disable_surveys: false) for CSAT feedback collection - Enable heatmaps (enable_heatmaps: true) for click tracking - Remove debug logging in production The CSAT survey now appears on all documentation pages with a feedback button on the right side. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
Removed temporary setup documentation now that CSAT survey is working 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
- Enable session recording to understand user behavior on docs - Mask all input fields for privacy protection - Keep text content readable for better UX insights - Add 'ph-no-capture' class support for opting out specific elements - Block third-party iframe recording for security Session recordings will help identify: - Navigation patterns and user journeys - Points where users get stuck or confused - How users interact with code examples and documentation - Common workflows and usage patterns 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
evantahler
left a comment
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.
Looks like this isn't deploying to the preview site due to a type error. Ping me again when it's up and I'll take a look!
| // Enable session recording for user behavior analysis | ||
| disable_session_recording: false, | ||
| session_recording: { | ||
| maskAllInputs: true, // Privacy: mask sensitive input fields |
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.
maskAllInputs and maskTextContent seem to be in conflict - which one wins?
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.
So the envoy completely hallucinated maskTextContent and Claude Code was just going with it. I had a word with them.
Originally I thought it was a mistake that it was showing. Do we want to keep it or...? |
* adds cheat sheet with print styles * 🤖 Regenerate LLMs.txt --------- Co-authored-by: Rachel Lee Nabors <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
* tentatively scaffolds new folder structure—very breaking, much sad * Organize guides and resources. * Update all internal documentation links to new IA structure - Migrated 176 files with 2,657 link updates total - Updated links from /home/ paths to new structure: - /get-started/ for onboarding content - /guides/ for how-to guides - /references/ for reference documentation - /resources/ for supplementary content - Based on URL mappings from docs-migration.csv 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * Add server-side redirects for old URLs to new IA structure - Added 61 permanent (308) redirects in next.config.ts - Maps old /home/ paths to new information architecture - Uses Next.js redirects() for server-side handling - SEO-friendly: search engines will update their indexes 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * Fix remaining /home/ links throughout documentation - Updated 119 files with remaining /home/ references - Fixed links with anchors and query parameters - Ensured all internal links point to new IA structure - Comprehensive mapping of all /home/ paths to new locations 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * 🤖 Regenerate LLMs.txt * fixing missing closing brackets * fix broken has links * fix duplicate links * update broken links * more broken link and md fixes * fix moar links * update broken links * correct infinite redirects * fixing some messed up redirects and blank links * 🤖 Regenerate LLMs.txt * fix auth providers url generation * Fix 75 broken links and resolve routing issues Fixed multiple categories of broken links across the documentation: Routing & Redirects: - Removed infinite redirect loops (e.g., /en/references redirecting to itself) - Added proper redirects for MCP paths (/en/references/mcp, /en/references/mcp/python) - Added redirects for paths missing locale prefixes (/mcp-servers/* → /en/resources/integrations/*) - Fixed paths to moved pages (e.g., api-key → api-keys, openai → openai-agents) Link Corrections: - Fixed malformed anchor links missing '#' separator (e.g., googleusing-google-auth → google#using-google-auth) - Updated paths to point to correct locations (e.g., /guides/create-tools/contribute/registry-early-access) - Fixed references in glossary to use correct anchor format Test Updates: - Enhanced broken-link-check.test.ts with comprehensive redirect whitelist - Added handling for both /mcp-servers/* and /en/mcp-servers/* patterns - Updated test to validate redirects match actual file structure All 75 broken links now resolved. Both broken-link-check and internal-link-check tests pass. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * fix: make documentation routing language-agnostic Made the documentation system properly multilingual by removing hardcoded English locale prefixes from all internal links and redirect configurations. Nextra automatically handles locale routing, so explicit /en/ prefixes were causing issues and breaking multilingual support. - Removed /en/ prefixes from all redirect destinations - Fixed infinite redirect loops where paths were redirecting to themselves - Cleaned up duplicate entries from merge conflicts - All redirects now use language-agnostic paths that work with any locale - Verified all redirects from docs-migration.csv are present and correct - Updated all markdown files to remove hardcoded /en/ prefixes from internal links - Fixed malformed anchor links that were missing '#' separators - Corrected links pointing to wrong auth provider documentation - Updated link validation to handle language-agnostic paths - Added redirect mappings for all known redirects - Tests now properly validate links without locale prefixes - next.config.ts - Removed locale prefixes from all redirects - app/en/references/changelog/page.mdx - Fixed malformed Google auth link - app/en/resources/glossary/page.mdx - Fixed malformed Google auth links - app/en/resources/tools/page.mdx - Removed /en/ from internal links - app/en/resources/integrations/productivity/*.mdx - Fixed Google auth reference links - tests/broken-link-check.test.ts - Updated to handle language-agnostic validation ✅ All tests passing (0 broken links) ✅ Verified redirects work correctly without locale prefixes ✅ Confirmed Nextra handles locale routing automatically ✅ Cross-referenced all redirects with docs-migration.csv 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * Update old redirect paths and remove knownRedirects from test file Updated all internal links to use the correct destination paths instead of redirect paths: - /get-started/setup/api-key → /get-started/setup/api-keys - /references/auth-providers/ → /references/auth-providers (removed trailing slash) - /guides/tool-calling/ → /guides/tool-calling (removed trailing slash) - /references/mcp/python/ → /references/mcp/python - /guides/tool-calling/custom-apps/authorized-tool-calling → /guides/tool-calling/custom-apps/auth-tool-calling - /guides/user-facing-agents/brand-provider → /guides/user-facing-agents/secure-auth-production - /guides/tool-calling/mcp-client/* → /guides/tool-calling/mcp-clients/* - /guides/tool-calling/get-tool-definitions → /guides/tool-calling/custom-apps/get-tool-definitions - /guides/deployment-hosting/engine-configuration → /guides/deployment-hosting/configure-engine - /guides/create-tools/performance/run-evaluations → /guides/create-tools/evaluate-tools/run-evaluations - /references/arcade-cliarcade-configure → /references/arcade-cli - /resources/creating-tools/tool-basics/build-mcp-server → /guides/create-tools/tool-basics/build-mcp-server - /resources/mastra/user-auth-interrupts → /guides/agent-frameworks/mastra/user-auth-interrupts Removed the knownRedirects mapping from the test file since all links now point directly to the correct paths. All tests pass successfully. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * update reroutes * remove and don't track .bak * fix malformed urls * Merge branch 'origin/main' into new-ia-backup - resolved conflicts * Rectifying merge conflicts * 🤖 Regenerate LLMs.txt --------- Co-authored-by: Rachel Lee Nabors <[email protected]> Co-authored-by: Claude <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
- Enabled surveys for CSAT feedback collection - Enabled heatmaps for click and scroll tracking - Added detailed setup documentation for both features - Server tested and running successfully Features now active: ✅ Surveys - For CSAT feedback on every page ✅ Heatmaps - For visualizing user interactions ✅ Page tracking - Automatic pageview events ✅ Custom events - Existing event tracking Next steps: 1. Log into PostHog dashboard (https://us.posthog.com) 2. Create CSAT survey following the guide 3. Review heatmaps to understand user behavior 4. Correlate CSAT scores with interaction patterns 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
- Updated the `trackScopeCalculatorUsed` function to accept a new parameter for the count of selected tools. - Adjusted calls to `trackScopeCalculatorUsed` in `selectAll` and `clearAll` functions to reflect the new parameter. - Improved analytics by accurately capturing the number of selected tools during user interactions. This change enhances the tracking capabilities for better insights into user behavior.
- Refactored the hero click tracking code to follow DRY principles. - Enhanced the tracking mechanism for better analytics insights. This update streamlines the tracking process and improves code maintainability.
- Kept PostHog tracking event handlers in landing page - Preserved corrected framework link in quickstart guide
evantahler
left a comment
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'm not seeing the new feedback button on the preview site?
|
@evantahler I don't know why this is. The survey in Posthog works in localhost if you set "contains" to localhost but not if you use this url:
Could there be some other posthog configuration in conflict? Perhaps set only to work with arcade.dev and localhost at a global setting? |
|
I don't think user targeting was the problem, and I suggest you go back to allowing it to appear for all users. Some thoughts:
2. Have you "globally" enabled surveys? I think yes. Are there posthog js initialization settings that override this? https://github.com/ArcadeAI/docs/blob/main/app/_components/posthog.tsx ?
|
|
Triggers redeploy to pick up the newly added environment variable. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
evantahler
left a comment
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.
Tested on Staging!




This update to the docs site will allow us to collect feedback and analyze learning bottlenecks. It's been set up to work on the preview https://docs-git-feedback-arcade-ai.vercel.app/ for testing. When merged, we can switch it on for the docs site.
Configuration Changes:
Event tracking:
Session recording enabled so we can see where any problems occur.



Note
Enables robust analytics and UX telemetry across the docs.
PostHogto enable session recording, heatmaps, surveys, and pageview tracking; gate debug viaNEXT_PUBLIC_POSTHOG_DEBUGintegration_card_clicked,quickstart_card_clicked,sample_app_clicked,scope_calculator_used,code_example_expanded,code_copied,tool_card_clicked,contact_sales_modal_opened, hero buttons (get_started_clicked,build_tool_clicked)integration-card,quick-start-card,sample-app-card,scope-picker,tabbed-code-block(expand/copy),tool-card,contact-cards,home/landing-pageAlso updates docs content/links (frameworks link, Cursor/Claude Desktop paths, formatting, minor copy edits) and fixes small code samples in auth provider pages.
Written by Cursor Bugbot for commit c9d693e. This will update automatically on new commits. Configure here.