Skip to content

feat: add tracking to docs site using reodev and google tag manager #247

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.

Sign up for GitHub

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

Merged
arora-saurabh448 merged 1 commit into from
Mar 18, 2026
Merged

feat: add tracking to docs site using reodev and google tag manager #247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/docs/overrides/main.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{% extends "base.html" %}

{% block extrahead %}
<!-- Start of Reo Javascript -->
<script type="text/javascript">
!function(){var e,t,n;e="e4fe6006f75148d",t=function(){Reo.init({clientID:"e4fe6006f75148d"})},(n=document.createElement("script")).src="https://static.reo.dev/"+e+"/reo.js",n.defer=!0,n.onload=t,document.head.appendChild(n)}();
</script>
<!-- End of Reo Javascript -->
{% endblock %}
3 changes: 2 additions & 1 deletion docs/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ copyright: "&copy; 2026 Altimate Inc. All rights reserved."

theme:
name: material
custom_dir: docs/overrides
Copy link

@sentry sentry bot Mar 18, 2026

Choose a reason for hiding this comment

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

Bug: The custom_dir is configured to be inside the docs_dir, which violates MkDocs constraints and will cause the documentation build to fail.
Severity: CRITICAL

Suggested Fix

Move the overrides directory to docs/overrides (making it a sibling to the documentation source files) and update the custom_dir setting in mkdocs.yml to overrides.

Prompt for AI Agent 
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.

Location: docs/mkdocs.yml#L11

Potential issue: The `custom_dir` is set to `docs/overrides` in `mkdocs.yml`. Since the
`docs_dir` is not explicitly set, it defaults to `docs`, resolving to `docs/docs/`. This
makes the `custom_dir` path (`docs/docs/overrides/`) a subdirectory of the `docs_dir`.
MkDocs explicitly validates that the `custom_dir` must not be a child of the `docs_dir`.
This misconfiguration will cause a validation error during the build phase, preventing
the documentation from being generated.

Did we get this right? 👍 / 👎 to inform future reviews.

logo: assets/logo.png
favicon: assets/images/favicon.png
font:
Expand Down Expand Up @@ -52,7 +53,7 @@ extra:
link: https://pypi.org/project/altimate-engine/
analytics:
provider: google
property: G-XXXXXXXXXX # TODO: Replace with actual GA4 property ID
property: G-C89Y5E4JJT
consent:
title: Cookie consent
description: >-
Expand Down
Loading