Skip to content

Conversation

@msynk
Copy link
Member

@msynk msynk commented Sep 3, 2025

closes #11336

Summary by CodeRabbit

  • Documentation

    • Expanded Getting Started with an “Optional components” accordion explaining Automatic Resource Fingerprinting via Bit.BlazorUI.Assets.
    • Included clear explanations and examples for script and stylesheet fingerprinting.
    • Added a reference link to the demo server usage for quick adoption.
  • Bug Fixes

    • Corrected a typo in the Getting Started note (“resrouce URLs” → “resource URLs”).

@coderabbitai
Copy link

coderabbitai bot commented Sep 3, 2025

Walkthrough

Adds an “Optional components” section to GettingStartedPage.razor describing Automatic Resource Fingerprinting via Bit.BlazorUI.Assets, including script/link fingerprinting examples and a reference note. Also fixes a typo (“resrouce” → “resource”). No functional or API changes.

Changes

Cohort / File(s) Summary
Docs/UI content update
src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/GettingStartedPage.razor
Added Optional components accordion with Automatic Resource Fingerprinting docs (script/link examples, reference link). Fixed a typo in note text.

Sequence Diagram(s)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Assessment against linked issues

Objective Addressed Explanation
Update Cache busting section to explain using new Script and Link components for automatic cache busting (#11336)

Assessment against linked issues: Out-of-scope changes

Poem

I twitch my whiskers, cache laid low,
With fingerprinted scripts that glow.
Links now dance with versioned flair,
No stale bits lurking in the air.
I thump—approved! Docs clear and bright,
Hop on, devs, your bytes take flight! 🐇✨

✨ Finishing Touches
🧪 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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@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

🧹 Nitpick comments (4)
src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/GettingStartedPage.razor (4)

140-147: Clarify namespace/import so Script/Link compile out of the box.

If these components live under a different namespace than Bit.BlazorUI, mention the required import (e.g., @using Bit.BlazorUI.Assets) here or in step 2 to prevent “component not found” build errors.

Proposed inline note:

             standalone components designed for automatic resource fingerprinting in the <BitTag Color="BitColor.TertiaryBackground">App.razor</BitTag> file:
           </BitText>
 
+          <BitText Typography="BitTypography.Body2">
+              <b>Note</b>: Ensure the namespace import for these components is available (e.g.,
+              <BitTag Color="BitColor.TertiaryBackground">&#64;using Bit.BlazorUI.Assets</BitTag>).
+          </BitText>

164-167: Use the correct lowercase HTML tag name in the narrative.

HTML uses , not .

-                <b>Link</b>: A direct replacement for the standard HTML <BitTag Color="BitColor.TertiaryBackground">&lt;Link></BitTag> tag.
+                <b>Link</b>: A direct replacement for the standard HTML <BitTag Color="BitColor.TertiaryBackground">&lt;link></BitTag> tag.

172-172: Fix HTML entity to render the example correctly.

Missing semicolon after &lt causes the literal “&ltlink” to render instead of “”.

-            <CodeBox>&ltlink href="_content/Bit.BlazorUI/styles/bit.blazorui.css?v=sha256-VI6BIGZLTtmyhn3V-4RH-Yyi0Ud3p0g5dHvByeaoZ9Y" rel="stylesheet"></CodeBox>
+            <CodeBox>&lt;link href="_content/Bit.BlazorUI/styles/bit.blazorui.css?v=sha256-VI6BIGZLTtmyhn3V-4RH-Yyi0Ud3p0g5dHvByeaoZ9Y" rel="stylesheet"></CodeBox>

176-181: Minor grammar improvement.

“checkout” → “check out”.

-                <b>Note</b>: You can checkout the usages of these two components in our demo website project
+                <b>Note</b>: You can check out the usages of these two components in our demo website project
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Knowledge Base: Disabled due to Reviews > Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between 296180a and fcd91b2.

📒 Files selected for processing (1)
  • src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/GettingStartedPage.razor (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: build and test
🔇 Additional comments (1)
src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/GettingStartedPage.razor (1)

135-135: Typo fix LGTM.

“resource URLs” correction reads well.

@msynk msynk merged commit dc2e7db into bitfoundation:develop Sep 3, 2025
3 checks passed
@msynk msynk deleted the 11336-blazorui-demo-update-cache-busting-docs branch September 3, 2025 16:03
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.

The Cache busting section of the BlazorUI getting started docs needs an update

1 participant