Skip to content

Add Umami analytics to the docs - #405

Merged
aspizu merged 1 commit into
mainfrom
add-umami-script
Nov 20, 2026
Merged

aspizu merged 1 commit into
mainfrom
add-umami-script

Conversation

@aspizu

@aspizu aspizu commented Nov 20, 2026

Copy link
Copy Markdown
Owner

Load the existing aspiz.uk Umami tracker on goboscript documentation pages through the MkDocs Material head template. The script and analytics endpoint resolve from the domain root.

Verified with pnpm run build:docs and checked the generated install and syntax pages for the tracker tag.


car-2x.png GPT 6.2 Astra on behalf of @aspizu

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 20, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-20T18:19:44.297733Z 470479d PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai

coderabbitai Bot commented Nov 20, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The MkDocs configuration now uses the overrides directory for custom templates. The template extends base.html and adds a deferred /stats.js script to the extrahead block.

Changes: MkDocs analytics script

Layer / File(s) Summary
Enable the statistics script
mkdocs.yml, overrides/main.html
The theme configuration selects overrides as the custom directory. The template adds a deferred /stats.js script with host URL / and the specified website ID.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: Minimal · up to 47047

This adds the Umami tracker tag to the documentation pages through a small template override. Whether the live host serves the script and records events can only be checked after deployment, and no code defect was found. Merge risk is minimal.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title "Add Umami analytics to the docs" matches the change. The PR adds the existing Umami tracker script to the MkDocs Material docs through an overrides/main.html template, and the mkdocs.yml ch…
Description check Passed The description states that the existing aspiz.uk Umami tracker loads on goboscript documentation pages through the MkDocs Material head template. This matches the overrides/main.html and mkdocs.yml c…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title "Add Umami analytics to the docs" matches the change. The PR adds the existing Umami tracker script to the MkDocs Material docs through an overrides/main.html template, and the mkdocs.yml change sets custom_dir to overrides. The title names the main change and is specific enough for a teammate scanning history.

Full details: Description check

Explanation

The description states that the existing aspiz.uk Umami tracker loads on goboscript documentation pages through the MkDocs Material head template. This matches the overrides/main.html and mkdocs.yml changes. It also gives the verification steps (pnpm run build:docs and checking generated pages for the tracker tag). The description is related to the changeset.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: QUIET
  • Plan: Advanced
  • Run ID: 1b50514f-fa7f-47cb-8c13-11a1595a870e
Commits

Reviewing files that changed from the base of the PR and between ec3ddf3 and 470479d.

Files selected for processing: 2

  • mkdocs.yml
  • overrides/main.html

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

@aspizu
aspizu merged commit 1e697de into main Nov 20, 2026
2 checks passed
@aspizu
aspizu deleted the add-umami-script branch November 20, 2026 18:20
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.

1 participant