Add Search Analytics Tracking to Documentation Site #275
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Rationale
Currently, our documentation search functionality doesn't track how users interact with search results, making it difficult to understand user behavior and improve search relevance. By implementing search analytics tracking, we can:
Changes
Added Features:
TypesenseSearchBox.vue
:Code Changes:
In
TypesenseSearchBox.vue
:guid
andcurrentQuery
data properties for trackingsendAnalyticsEvent
method to handle analytics event submissionIn
.vuepress/config.js
:id
field to included fields in search paramsConfiguration Updates:
.gitignore
:.env
to protect sensitive configurationContext
This change is part of our initiative to improve search relevance by understanding how users interact with our documentation search. The analytics events are anonymized and only track:
These analytics will help us:
PR Checklist