Skip to content

Conversation

cnaallotey
Copy link
Contributor

@cnaallotey cnaallotey commented Sep 11, 2025

This PR is to update Vue School Banner script to https://media.bitterbrains.com/main.js to prevent adblockers.

Summary by CodeRabbit

  • Documentation
    • Updated the top banner on the documentation site to use a new script source while preserving existing behavior.
    • Banner continues to load asynchronously and should not impact page performance or navigation.
    • No changes to documentation content or structure; the update only affects the promotional banner display across pages.
    • Users may notice minor visual or tracking improvements tied to the banner, with no required action.

Copy link
Contributor

coderabbitai bot commented Sep 11, 2025

Walkthrough

Updated the external Vue School top banner script URL in the docs VitePress shared config. The script tag’s attributes (async, type) and the rest of the configuration remain unchanged.

Changes

Cohort / File(s) Change Summary
Docs banner script update
packages/docs/.vitepress/config/shared.ts
Replaced script src URL from https://vueschool.io/banner.js?affiliate=vuerouter&type=top to https://media.bitterbrains.com/main.js?from=vuerouter&type=top; no other modifications.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks (3 passed)

✅ 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 accurately describes the primary change (updating the Vue School banner script URL to avoid adblocker interference) and aligns with the PR description and file-level change in the docs config; it is concise, focused, and uses the conventional "feat:" prefix. The title is clear enough for a teammate scanning history to understand the main intent. The only minor nitpick is the lowercase "vueschool" instead of "Vue School," but that does not make the title misleading.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

Poem

I nibbled the link, a tiny hop,
From vueschool fields to bitterbrains crop.
Async winds still softly blow,
The banner’s path now set to go.
Thump-thump! says QA, all clear, all right—
Small change, swift paws, merged by night. 🐇✨

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

netlify bot commented Sep 11, 2025

Deploy Preview for vue-router ready!

Name Link
🔨 Latest commit 8498839
🔍 Latest deploy log https://app.netlify.com/projects/vue-router/deploys/68c2d32341f18b00081435d0
😎 Deploy Preview https://deploy-preview-2550--vue-router.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 90 (🟢 up 18 from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (🔴 down 8 from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
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: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
packages/docs/.vitepress/config/shared.ts (1)

111-115: Add media.bitterbrains.com to CSP/script-src (Netlify headers)

repo has netlify.toml at the root but no Content-Security-Policy/script-src or allowlist for media.bitterbrains.com was found; the script in packages/docs/.vitepress/config/shared.ts (lines 111–115) loads https://media.bitterbrains.com and will be blocked if CSP is enforced. Add the host to your site CSP (netlify.toml or _headers). Example (netlify.toml):

[[headers]]
for = "/*"
[headers.values]
Content-Security-Policy = "default-src 'self'; script-src 'self' https://media.bitterbrains.com;"

🧹 Nitpick comments (3)
packages/docs/.vitepress/config/shared.ts (3)

112-114: Avoid @ts-expect-error: emit boolean attribute as empty string (consistent with Fathom).

VitePress head attrs are typed as strings; using async: '' removes the need for the TS override and matches the style used for defer.

Apply this diff:

-        // @ts-expect-error: vitepress bug
-        async: true,
+        async: '',

111-115: Optional: use defer for deterministic execution order.

If the banner script doesn’t need to run before parsing finishes, defer provides more predictable timing than async. Keep async if early paint of the banner is desired.


111-115: Nit: preconnect/dns-prefetch to reduce first-load latency.

Add resource hints for the new host.

Outside this hunk, append in head:

['link', { rel: 'preconnect', href: 'https://media.bitterbrains.com' }],
['link', { rel: 'dns-prefetch', href: '//media.bitterbrains.com' }],
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e7ce331 and 8498839.

📒 Files selected for processing (1)
  • packages/docs/.vitepress/config/shared.ts (1 hunks)
🔇 Additional comments (2)
packages/docs/.vitepress/config/shared.ts (2)

111-111: LGTM — URL swap matches the PR goal.

The change aligns with the adblocker-prevention objective and keeps the rest of the config intact.


111-111: Confirm query param name change (affiliatefrom).

Previous URL used affiliate=vuerouter; new one uses from=vuerouter. Please verify with the vendor that from is recognized for attribution/tracking.

@posva posva merged commit b6fbdab into vuejs:main Sep 12, 2025
5 checks passed
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