Skip to content

docs: update GuruBase widget script in gurubase.js, improve formattin…#2465

Merged
tolgaozen merged 1 commit intomasterfrom
update-gurubase-widget
Sep 10, 2025
Merged

docs: update GuruBase widget script in gurubase.js, improve formattin…#2465
tolgaozen merged 1 commit intomasterfrom
update-gurubase-widget

Conversation

@tolgaozen
Copy link
Copy Markdown
Member

@tolgaozen tolgaozen commented Sep 10, 2025

…g in README.

Summary by CodeRabbit

  • Chores
    • Disabled the GuruBase support widget on documentation pages. The floating assistant will no longer appear or load, with no impact on page layout or navigation.
  • Documentation
    • Updated performance test docs: renamed the metric label "{ expected_response:true }" to "expected_response" for clarity and consistency. Numerical results and formatting remain unchanged.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Sep 10, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The Gurubase widget-loading code in docs/gurubase.js is fully commented out, disabling execution. A documentation label in docs/performance-test/README.md is renamed from "{ expected_response:true }" to "expected_response". No exported/public APIs are changed.

Changes

Cohort / File(s) Summary of changes
GuruBase widget loading disabled
docs/gurubase.js
Wrapped the entire GuruBase widget-loading sequence in a block comment, preventing script creation and append from executing.
Docs metrics label update
docs/performance-test/README.md
Renamed a metric label in the Read/Test Results table from "{ expected_response:true }" to "expected_response".

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant User as User
  participant Page as Docs Page
  participant GBJS as docs/gurubase.js
  participant Widget as GuruBase Widget

  User->>Page: Load docs page
  Page->>GBJS: Include gurubase.js
  rect #F8F9FA
    note over GBJS: Widget-loading code is commented out
    GBJS-->>Page: No script injected
  end
  Page-xWidget: (Widget not loaded)
  note over Page: Page continues without GuruBase widget
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • EgeAytin

Poem

A bunny paused mid-hop to see,
The Guru’s script—now comment, free.
A label trimmed, so neat, concise,
The docs now speak in cleaner spice.
I twitch my whiskers, stamp my feet—
Fewer widgets, metrics neat. 🐇✨

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.


📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 346f35d and 7cb45d2.

📒 Files selected for processing (2)
  • docs/gurubase.js (2 hunks)
  • docs/performance-test/README.md (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch update-gurubase-widget

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.

@tolgaozen tolgaozen merged commit 5fd59d9 into master Sep 10, 2025
8 of 10 checks passed
@tolgaozen tolgaozen deleted the update-gurubase-widget branch September 10, 2025 14: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