Skip to content

Add TYPO3 integration guide#934

Open
derhofbauer wants to merge 5 commits intorybbit-io:masterfrom
derhofbauer:master
Open

Add TYPO3 integration guide#934
derhofbauer wants to merge 5 commits intorybbit-io:masterfrom
derhofbauer:master

Conversation

@derhofbauer
Copy link
Copy Markdown

@derhofbauer derhofbauer commented Mar 11, 2026

This PR adds an integration guide for the TYPO3 CMS. It is based on the existing integration guide for Laravel.

I used this exact setup in multiple websites already and it works perfectly fine.

Summary by CodeRabbit

  • Documentation
    • New TYPO3 integration guide explaining how to add the Rybbit tracking script to a TYPO3 sitepackage.
    • Step-by-step instructions for locating TypoScript setup, registering the site ID, and storing configuration constants.
    • Examples showing injection via the page object, use of defer and data-site-id attributes, and conditional production-only loading.
    • Verification steps to confirm tracking data appears in the Rybbit dashboard, with code snippets and step blocks.

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 11, 2026

Someone is attempting to deploy a commit to the goldflag's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 11, 2026

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Adds a new documentation page explaining how to integrate Rybbit Analytics into a TYPO3 sitepackage via TypoScript: obtaining the tracking script, injecting it with page.includeJS (defer, data-site-id), optional production-only loading, constants configuration, and verification steps.

Changes

Cohort / File(s) Summary
TYPO3 Integration Guide
docs/content/docs/guides/typo3.mdx
New documentation page with step-by-step instructions for integrating Rybbit Analytics into TYPO3 sitepackages: obtaining the tracking script, TypoScript page integration (includeJS, defer, data-site-id), optional production-only loading via applicationContext, constants guidance, and dashboard verification steps.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I hopped through TypoScript neat and spry,
I tucked the tracker where pages fly,
Defer the script, set data-site-id true,
Only load in prod when context says do,
Carrots for analytics, a hop and a view 🥕

🚥 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 'Add TYPO3 integration guide' directly and clearly describes the main change—adding new documentation for TYPO3 integration, which aligns with the changeset that adds docs/content/docs/guides/typo3.mdx.
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
📝 Coding Plan
  • Generate coding plan for human review comments

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

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 5

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/content/docs/guides/typo3.mdx`:
- Line 101: Replace the misspelled word "evets" with "events" in the sentence
"for the first evets to appear." within the docs/guides/typo3.mdx content so it
reads "for the first events to appear."
- Line 68: The TypoScript condition string [applicationContext == "Production]
is missing a closing double-quote; update the condition to include the closing
quote (i.e., change [applicationContext == "Production] to [applicationContext
== "Production"]) so the quotes are balanced and the TypoScript condition parses
correctly; verify the line containing the condition exactly matches the
corrected string.
- Line 16: Fix the typo in the guide text: replace the incorrect word "Rybitt"
with the correct "Rybbit" in the sentence that begins "First, you'll need your
Rybbit tracking script." (search for the string "First, you'll need your Rybitt
tracking script." in the docs/guides content and update it to use "Rybbit").
- Line 71: The assignment line for the rybbit script uses angle brackets around
the URL ("rybbit = <https://app.rybbit.io/api/script.js>"); remove the
surrounding "<" and ">" so the value is a plain URL (matching the format used on
line 47) to ensure valid TypoScript parsing.
- Line 88: The sentence fragment "which you'll when you want to add the values
to the GIT repository." is missing a word; update that fragment to "which you'll
need when you want to add the values to the GIT repository." so the sentence
reads correctly (look for the exact string "which you'll when you want to add
the values to the GIT repository." in the docs content and insert "need" after
"you'll").

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b3b9e801-7b04-4309-a96d-8b36aaab59c1

📥 Commits

Reviewing files that changed from the base of the PR and between 3674af1 and 6c3a758.

📒 Files selected for processing (1)
  • docs/content/docs/guides/typo3.mdx

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/content/docs/guides/typo3.mdx`:
- Line 88: Replace the incorrect all-caps "GIT" in the sentence "you'll use when
you want to add the values to the GIT repository." with the proper
capitalization "Git" so the sentence reads "...add the values to the Git
repository."; update the string in the docs/content/docs/guides/typo3.mdx where
that exact phrase appears.
- Around line 49-51: The TypoScript shown uses an invalid nested block for data
attributes (rybbit.data { data-site-id = ... }), so replace the nested block
with flat TypoScript key/value notation for the data attribute (use the flat key
that combines the parent and attribute, e.g. rybbit.data-site-id = YOUR_SITE_ID)
so the includeJS/data attribute parses correctly; update the occurrence of
"rybbit.data" and "data-site-id" accordingly.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: bba41ff1-4a91-4932-8bbe-c48a4af72e73

📥 Commits

Reviewing files that changed from the base of the PR and between aae95d2 and 17ae5a7.

📒 Files selected for processing (1)
  • docs/content/docs/guides/typo3.mdx

derhofbauer and others added 3 commits March 18, 2026 11:53
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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