Skip to content

docs: Add analytics to documentation site#173

Merged
chrisk314 merged 3 commits intomainfrom
docs/analytics
Nov 5, 2025
Merged

docs: Add analytics to documentation site#173
chrisk314 merged 3 commits intomainfrom
docs/analytics

Conversation

@toby-coleman
Copy link
Contributor

Summary

Enables analytics on the documentation site, so that we can understand which pages are most useful to users.

Changes

  • Enable Google Analytics.
  • Add cookie notice.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @toby-coleman, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request integrates analytics into the documentation site to gain insights into user behavior and the effectiveness of the content. By tracking page views and user interactions, the team can identify which pages are most useful and continuously improve the documentation. Additionally, a cookie consent mechanism has been implemented to ensure transparency and compliance regarding data collection.

Highlights

  • Google Analytics Integration: Google Analytics has been enabled on the documentation site to track user engagement and page utility, using property ID G-99NL59QL5D.
  • Cookie Consent Notice: A cookie consent notice has been added to inform users about data collection for improving documentation and to provide an option to manage cookie settings.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request enables Google Analytics and adds a cookie consent notice to the documentation site. The changes in mkdocs.yaml correctly configure these features for the mkdocs-material theme. I have one suggestion to improve maintainability by using an environment variable for the Google Analytics property ID, which avoids hardcoding it in the repository.

@github-actions
Copy link

github-actions bot commented Nov 2, 2025

Benchmark comparison for 79419bc7 (base) vs 10215258 (PR)


------------------------------------------------------------------------------------------------------------------- benchmark: 2 tests ------------------------------------------------------------------------------------------------------------------
Name (time in ms)                                                                         Min                 Max                Mean             StdDev              Median                IQR            Outliers     OPS            Rounds  Iterations
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
test_benchmark_process_run (main/.benchmarks/Linux-CPython-3.12-64bit/0001_base)     440.8604 (1.0)      456.9295 (1.0)      447.2009 (1.0)       6.1731 (1.0)      445.6118 (1.0)       7.9051 (1.0)           2;0  2.2361 (1.0)           5           1
test_benchmark_process_run (pr/.benchmarks/Linux-CPython-3.12-64bit/0001_pr)         448.7434 (1.02)     517.4408 (1.13)     469.8276 (1.05)     28.0078 (4.54)     461.0141 (1.03)     31.8553 (4.03)          1;0  2.1284 (0.95)          5           1
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Legend:
  Outliers: 1 Standard Deviation from Mean; 1.5 IQR (InterQuartile Range) from 1st Quartile and 3rd Quartile.
  OPS: Operations Per Second, computed as 1 / Mean

@codecov
Copy link

codecov bot commented Nov 2, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@github-actions
Copy link

github-actions bot commented Nov 3, 2025

Benchmark comparison for 79419bc7 (base) vs fa3be3cb (PR)


------------------------------------------------------------------------------------------------------------------- benchmark: 2 tests ------------------------------------------------------------------------------------------------------------------
Name (time in ms)                                                                         Min                 Max                Mean             StdDev              Median                IQR            Outliers     OPS            Rounds  Iterations
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
test_benchmark_process_run (main/.benchmarks/Linux-CPython-3.12-64bit/0001_base)     444.9449 (1.0)      450.2193 (1.0)      447.5532 (1.0)       2.0410 (1.0)      447.1329 (1.0)       2.9986 (1.0)           2;0  2.2344 (1.0)           5           1
test_benchmark_process_run (pr/.benchmarks/Linux-CPython-3.12-64bit/0001_pr)         448.6095 (1.01)     490.4109 (1.09)     466.9026 (1.04)     18.3721 (9.00)     457.0907 (1.02)     30.4633 (10.16)         1;0  2.1418 (0.96)          5           1
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Legend:
  Outliers: 1 Standard Deviation from Mean; 1.5 IQR (InterQuartile Range) from 1st Quartile and 3rd Quartile.
  OPS: Operations Per Second, computed as 1 / Mean

@chrisk314 chrisk314 merged commit 1e9767b into main Nov 5, 2025
18 checks passed
@chrisk314 chrisk314 deleted the docs/analytics branch November 5, 2025 16:43
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