doc(BaiduOcr): add config documentation #6690

ArgoZhang · 2025-08-28T03:12:28Z

Link issues

fixes #6689

Summary By Copilot

Regression?

Yes
No

Risk

High
Medium
Low

Verification

Manual (required)
Automated

Packaging changes reviewed?

Yes
No
N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

Doc is updated/provided or not needed
Demo is updated/provided or not needed
Merge the latest code from the main branch

Summary by Sourcery

Provide configuration documentation in the BaiduOcr sample and refactor its component code structure, injection, and loading state handling.

Enhancements:

Move service, localization, and toast injections from the Razor page to the code-behind with [Inject, NotNull] attributes
Rename the loading state field to _isLoading and consolidate icon logic into a single property
Update sample component markup to adjust button disabling binding and ensure proper tag closures

Documentation:

Add configuration documentation and code snippets for BaiduOcr options in the sample component

sourcery-ai · 2025-08-28T03:12:33Z

Reviewer's Guide

This PR enriches the BaiduOcr sample with configuration documentation steps and refactors its implementation by centralizing dependency injection in the code-behind, renaming the loading state variable, and applying minor code style improvements.

Class diagram for refactored BaiduOcr component

classDiagram
    class BaiduOcr {
        +IBaiduOcr OcrService
        +IStringLocalizer<BaiduOcr> Localizer
        +ToastService ToastService
        -InvoiceEntity Invoice
        -bool _isLoading
        -string Icon
        +OnClickToUploadBlock(UploadFile file)
    }
    BaiduOcr ..> IBaiduOcr
    BaiduOcr ..> IStringLocalizer
    BaiduOcr ..> ToastService
    BaiduOcr ..> InvoiceEntity
    UploadFile --> BaiduOcr: used in OnClickToUploadBlock

File-Level Changes

Change	Details	Files
Added configuration documentation steps in the Razor sample	Inserted JSON snippet illustrating BaiduOcrOption settings Added code-label paragraphs for step-by-step instructions Introduced and expanded introduction text	`src/BootstrapBlazor.Server/Components/Samples/BaiduOcr.razor`
Moved dependency injection from markup to code-behind	Removed @Inject directives from the .razor file Added [Inject, NotNull] properties for IBaiduOcr, IStringLocalizer, and ToastService	`src/BootstrapBlazor.Server/Components/Samples/BaiduOcr.razor` `src/BootstrapBlazor.Server/Components/Samples/BaiduOcr.razor.cs`
Renamed loading state variable and updated related logic	Renamed IsLoading to private field _isLoading Adjusted Icon property to use the new field and inline icon strings Updated markup binding to reference _isLoading	`src/BootstrapBlazor.Server/Components/Samples/BaiduOcr.razor` `src/BootstrapBlazor.Server/Components/Samples/BaiduOcr.razor.cs`
Applied code style refinements	Converted null/length check to pattern matching for payload Switched self-closing tag to explicit opening/closing form	`src/BootstrapBlazor.Server/Components/Samples/BaiduOcr.razor` `src/BootstrapBlazor.Server/Components/Samples/BaiduOcr.razor.cs`
Updated localization files with new documentation keys	Added or modified keys for BaiduOcr configuration steps and descriptions	`src/BootstrapBlazor.Server/Locales/en-US.json` `src/BootstrapBlazor.Server/Locales/zh-CN.json`

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#6689	Add documentation for BaiduOcr configuration to the relevant code or documentation files.	✅

Possibly linked issues

doc(BaiduOcr): add config documentation #6689: The PR adds documentation for BaiduOcr configuration, including appsettings.json options and service injection steps.

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey there - I've reviewed your changes and they look great!

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

Copilot

Pull Request Overview

This pull request adds configuration documentation for the BaiduOcr component by updating the localization files and improving the code structure. The change primarily focuses on enhancing the user guidance for setting up the BaiduOcr service.

Key changes:

Added step-by-step configuration documentation with appsettings.json example
Updated localization strings in both Chinese and English versions
Improved code structure by moving dependency injections to properties and modernizing syntax
Enhanced the documentation display with proper code examples

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File	Description
src/BootstrapBlazor.Server/Locales/zh-CN.json	Added new localization keys for configuration steps and descriptions in Chinese
src/BootstrapBlazor.Server/Locales/en-US.json	Added corresponding English localization strings for configuration documentation
src/BootstrapBlazor.Server/Components/Samples/BaiduOcr.razor.cs	Moved dependency injections from inline to properties and modernized code syntax
src/BootstrapBlazor.Server/Components/Samples/BaiduOcr.razor	Updated template to display new configuration documentation and use property-based dependencies

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

src/BootstrapBlazor.Server/Locales/zh-CN.json

src/BootstrapBlazor.Server/Locales/en-US.json

src/BootstrapBlazor.Server/Components/Samples/BaiduOcr.razor

codecov · 2025-08-28T03:14:45Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (6d3d2f9) to head (189dc3e).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main     #6690   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          739       739           
  Lines        31698     31698           
  Branches      4462      4462           
=========================================
  Hits         31698     31698

Flag	Coverage Δ
BB	`100.00% <ø> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

ArgoZhang added 4 commits August 28, 2025 10:17

doc: 文档格式化

6872be7

doc: 更新配置文档

e3abd74

doc: 更新资源文件

96e1898

doc: 更新文档

189dc3e

Copilot AI review requested due to automatic review settings August 28, 2025 03:12

bb-auto bot assigned ArgoZhang Aug 28, 2025

bb-auto bot added the documentation Improvements or additions to documentation label Aug 28, 2025

bb-auto bot added this to the 9.9.0 milestone Aug 28, 2025

ArgoZhang enabled auto-merge (squash) August 28, 2025 03:12

sourcery-ai bot approved these changes Aug 28, 2025

View reviewed changes

Copilot AI reviewed Aug 28, 2025

View reviewed changes

src/BootstrapBlazor.Server/Locales/zh-CN.json Show resolved Hide resolved

src/BootstrapBlazor.Server/Locales/en-US.json Show resolved Hide resolved

src/BootstrapBlazor.Server/Components/Samples/BaiduOcr.razor Show resolved Hide resolved

ArgoZhang merged commit c986015 into main Aug 28, 2025
6 checks passed

ArgoZhang deleted the doc-ocr branch August 28, 2025 03:42

This was referenced Sep 16, 2025

Bump the major group with 21 updates qin-guan/Homer#41

Closed

Bump the minor group with 21 updates qin-guan/Homer#42

Closed

Bump the minor group with 21 updates qin-guan/Homer#43

Closed

Bump the minor group with 21 updates qin-guan/Homer#44

Closed

dependabot bot mentioned this pull request Sep 25, 2025

Bump the minor group with 21 updates qin-guan/Homer#45

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

doc(BaiduOcr): add config documentation #6690

doc(BaiduOcr): add config documentation #6690

ArgoZhang commented Aug 28, 2025 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented Aug 28, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Aug 28, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

doc(BaiduOcr): add config documentation #6690

doc(BaiduOcr): add config documentation #6690

Conversation

ArgoZhang commented Aug 28, 2025 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Link issues

Summary By Copilot

Regression?

Risk

Verification

Packaging changes reviewed?

☑️ Self Check before Merge

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Aug 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide

Class diagram for refactored BaiduOcr component

File-Level Changes

Assessment against linked issues

Possibly linked issues

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Aug 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

ArgoZhang commented Aug 28, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Aug 28, 2025 •

edited

Loading

codecov bot commented Aug 28, 2025 •

edited

Loading