ci: add reo tracker

[ossdhaval]

Added reo.dev tracker to the Flex documentation

Summary by CodeRabbit

• Chores
  • Enhanced documentation build workflow to dynamically fetch the latest template overrides from the main branch and conditionally enable tracking features during manual deployments and release events
  • Added new configuration options to selectively enable Scarf pixel and REO script analytics tracking in versioned documentation for improved monitoring capabilities

[coderabbitai]

Warning

Rate limit exceeded

@ossdhaval has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 1 minutes and 43 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: f6c8de4d-8d79-4d62-b90a-fa59a8554c69

📥 Commits

Reviewing files that changed from the base of the PR and between 6086518 and 58053d3.

📒 Files selected for processing (1)

• docs/assets/js/reo.js

📝 Walkthrough

Walkthrough

The changes introduce tracking infrastructure for documentation by adding GitHub Actions workflow steps to fetch template overrides and conditionally enable tracking flags, a new HTML template for conditional tracking pixel and script inclusion, and configuration settings to control these features.

Changes

Cohort / File(s)	Summary
GitHub Actions Workflow .github/workflows/build-docs.yml	Adds two new steps before mike deploy: one fetches template overrides from main branch when triggered by workflow_dispatch or release events; another enables Scarf and Reo tracking flags in mkdocs.yml under the same conditions.
Template Overrides docs/overrides/main.html	New Jinja2 template extending base.html with conditional inclusions: a 0x0 Scarf tracking pixel when enable_scarf_pixel is true, and a deferred Reo tracking script when enable_reo_flag is true.
MkDocs Configuration mkdocs.yml	Adds custom theme directory pointing to docs/overrides and introduces two boolean feature flags: enable_scarf_pixel and enable_reo_flag (both default to false).

Sequence Diagram

sequenceDiagram
    participant GHA as GitHub Actions
    participant Git as Git Repository
    participant MkDocs as MkDocs Build
    participant Template as HTML Template
    participant Tracking as Tracking Services

    GHA->>Git: Fetch template overrides from main
    Git-->>GHA: main.html
    GHA->>MkDocs: Update tracking flags in mkdocs.yml
    Note over MkDocs: enable_scarf_pixel: true<br/>enable_reo_flag: true
    GHA->>MkDocs: Build documentation
    MkDocs->>Template: Render with config
    Template->>Tracking: Conditionally include<br/>Scarf pixel & Reo script
    Tracking-->>Template: Tracking loaded
    Template-->>MkDocs: HTML generated
    MkDocs->>GHA: Build complete
    GHA->>Git: Deploy with mike

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 Hops of joy! Tracking pixels bright,
Reo scripts dance into the night,
Template overrides from the main,
Docs deploy—no need to strain! ✨📚

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'ci: add reo tracker' accurately captures the main change - adding reo tracker integration to the CI workflow. It is concise, specific, and clearly summarizes the primary modification across the three files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch ci-reo-integration

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/workflows/build-docs.yml:
- Around line 133-144: The workflow currently enables the Reo tracker by setting
enable_reo_flag: true (via the sed command that edits mkdocs.yml) but the
required asset docs/assets/js/reo.js is missing; either stop enabling the flag
or add the asset. Fix by removing or disabling the sed line that sets
enable_reo_flag: true in the build-docs workflow (the sed command referencing
enable_reo_flag) or, if you want tracking, add a valid docs/assets/js/reo.js
file to the repo (and ensure the git show origin/main:docs/assets/js/reo.js
reference will succeed) so the tracker script is present when the flag is
enabled.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: b6c1aba6-5c91-4555-affb-35b2b8bee690

📥 Commits

Reviewing files that changed from the base of the PR and between dc3bdd5 and 6086518.

📒 Files selected for processing (3)

• .github/workflows/build-docs.yml
• docs/overrides/main.html
• mkdocs.yml