Update BlazorUI documentation (#9826)

[msynk]

closes #9826

Summary by CodeRabbit

• Documentation
  • Enhanced product documentation by rephrasing titles and instructions for clarity, ensuring integration guidelines now focus on a single primary reference.
  • Streamlined setup instructions for various components, emphasizing simplicity and ease of use.
• Style
  • Improved textual formatting and layout on guide pages, including clearer bullet-point benefit lists and emphasized content for better readability.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This pull request updates documentation across several projects. The Bit.BlazorUI README has been rephrased and restructured with a new title, enhanced description, and bullet-pointed benefits, along with an added Getting Started section. The GettingStartedPage.razor file now features bold text, improved spacing via
tags, and updated file reference instructions pointing to App.razor instead of legacy pages. Additionally, both Bswup and Bup README files have been modified to reference App.razor for integration details. No changes were made to functionality or public entity declarations.

Changes

File(s)	Change Summary
src/BlazorUI/Bit.BlazorUI/README.md	Rephrased title and description; reformatted benefits into bullet points; introduced a new Getting Started section with clarified installation instructions.
src/BlazorUI/Demo/Client/.../GettingStartedPage.razor	Added bold formatting and extra spacing; updated instructions to replace _Host.cshtml/_Layout.cshtml with App.razor in the CSS/JS file reference sections.
src/Bswup/README.md, src/Bup/README.md	Updated integration instructions by replacing _Host.cshtml/_Layout.cshtml references with App.razor; refined script tag details for service worker integration.

Assessment against linked issues

Objective	Addressed	Explanation
Update documentation content for the BlazorUI project (#9826)	✅

Poem

I'm a rabbit hopping through docs anew,
Rewording lines with a twitch and a cue.
Bullet points and steps all shining bright,
In the code garden, everything's just right!
With carrots and clarity, I celebrate this byte! 🥕🐇

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• 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 src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai 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

Documentation and Community

• 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/GettingStartedPage.razor (1)

72-72: Fix typo in JS file reference instruction.

The instruction has a duplicate word "file".

-then add the JS file file reference:
+then add the JS file reference:

src/BlazorUI/Bit.BlazorUI/README.md (1)

41-41: Format the documentation URL properly.

The bare URL should be properly formatted as a Markdown link.

-5. Start using BlazorUI components in pages/components following its documents: https://blazorui.bitplatform.dev
+5. Start using BlazorUI components in pages/components following its [documentation](https://blazorui.bitplatform.dev)

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

41-41: Bare URL used
null

(MD034, no-bare-urls)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6b18729 and c7ab3b1.

📒 Files selected for processing (4)

• src/BlazorUI/Bit.BlazorUI/README.md (2 hunks)
• src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/GettingStartedPage.razor (2 hunks)
• src/Bswup/README.md (1 hunks)
• src/Bup/README.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• src/Bup/README.md

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

src/BlazorUI/Bit.BlazorUI/README.md

41-41: Bare URL used
null

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: build and test

🔇 Additional comments (7)

src/Bswup/README.md (2)

30-34: Updated Default Document Instruction:
This section now specifies that both "index.html" and "App.razor" are valid default documents for adding the Blazor script, along with the addition of autostart="false". This update helps clarify the integration process for modern Blazor apps and aligns with the new recommended practices.

---

36-44: Enhanced bit-bswup Script Tag Details:
The revised instruction for adding the "bit-bswup.js" script tag now clearly lists the necessary attributes (scope, log, sw, handler) in the context of both "index.html" and "App.razor". This consistency in documentation makes it easier for developers to correctly configure the service worker.

src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/GettingStartedPage.razor (2)

14-16: LGTM! Improved text formatting and spacing.

The bold formatting and additional line breaks enhance readability and visual hierarchy.

Also applies to: 21-22, 26-26

---

68-68: LGTM! Updated file references to modern Blazor practices.

The changes correctly reference App.razor while maintaining compatibility with index.html.

src/BlazorUI/Bit.BlazorUI/README.md (3)

1-1: LGTM! Enhanced title and description.

The updated title and description better convey the library's value proposition and technical independence.

Also applies to: 4-4

---

7-10: LGTM! Well-structured benefits section.

The bullet points and enhanced descriptions effectively communicate the key advantages of the library.

---

12-40: LGTM! Clear and comprehensive getting started guide.

The step-by-step instructions are well-organized and easy to follow.