Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc(CodeSnippetService): update code file path #4877

Merged
merged 3 commits into from
Dec 18, 2024
Merged

doc(CodeSnippetService): update code file path #4877

merged 3 commits into from
Dec 18, 2024

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Dec 18, 2024

update code file path

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #4876

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

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

Update file paths in the CodeSnippetService and various components to point to the correct server directory, addressing inconsistencies and fixing related issues.

Bug Fixes:

  • Correct file paths in the CodeSnippetService to point to the correct server directory instead of the shared directory.

Enhancements:

  • Update various component and sample file paths to reflect the correct server directory, ensuring consistency across the project.

@bb-auto bb-auto bot added the documentation Improvements or additions to documentation label Dec 18, 2024
Copy link

sourcery-ai bot commented Dec 18, 2024

Reviewer's Guide by Sourcery

This PR updates file paths across the codebase, replacing references to 'BootstrapBlazor.Shared' with 'BootstrapBlazor.Server'. The changes are primarily in documentation links, file paths for resource loading, and API endpoints.

Class diagram for CodeSnippetService changes

classDiagram
    class CodeSnippetService {
        - string ServerUrl
        - string ContentRootPath
        - string SourceCodePath
        - bool IsDevelopment
        + Task<string> GetFileContentAsync(string fileName)
        + Task<string> ReadFileAsync(string fileName)
    }
    note for CodeSnippetService "Updated file paths from BootstrapBlazor.Shared to BootstrapBlazor.Server"
Loading

File-Level Changes

Change Details Files
Updated file paths in code snippets and documentation references
  • Changed AppDomainName from 'BootstrapBlazor.Shared' to 'BootstrapBlazor.Server'
  • Updated IISRootPath to point to Server directory instead of Shared
  • Modified stack trace file paths to reflect new directory structure
src/BootstrapBlazor.Server/Components/Samples/GlobalException.razor
Modified API endpoint and file reading paths in CodeSnippetService
  • Updated API endpoint path to use Server instead of Shared directory
  • Modified file reading paths for both development and production environments
src/BootstrapBlazor.Server/Services/CodeSnippetService.cs
Updated documentation links and source code references
  • Changed Gitee repository links to point to Server directory
  • Updated class documentation references to new file locations
  • Modified source code URLs in comments
src/BootstrapBlazor.Server/Components/Samples/Table/*.razor.cs
src/BootstrapBlazor.Server/Components/Samples/*.razor.cs
Updated resource loading paths
  • Modified localization file paths to use Server directory
  • Updated path for searching resource files
src/BootstrapBlazor.Server/Components/Pages/Localization.razor
src/BootstrapBlazor.Server/Components/Samples/Tutorials/Translation/Translator.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#4876 Update code file paths from BootstrapBlazor.Shared to BootstrapBlazor.Server

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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

@bb-auto bb-auto bot added this to the v9.0.0 milestone Dec 18, 2024
@ArgoZhang ArgoZhang merged commit 52d30ad into main Dec 18, 2024
2 checks passed
@ArgoZhang ArgoZhang deleted the doc-server branch December 18, 2024 02:23
Copy link

codecov bot commented Dec 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@d4f3675). Learn more about missing BASE report.
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff            @@
##             main     #4877   +/-   ##
========================================
  Coverage        ?   100.00%           
========================================
  Files           ?       623           
  Lines           ?     27832           
  Branches        ?      3982           
========================================
  Hits            ?     27832           
  Misses          ?         0           
  Partials        ?         0           

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc(CodeSnippetService): update code file path
1 participant