doc(Install): upate Install documentation #7005
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reviewer's GuideThis PR completely revamps the Install documentation by replacing the old Git-and-NuGet workflow with a localized, step-by-step guide, removes outdated install component files and assets, and cleans up redundant install menu entries. Entity relationship diagram for removed install menu entrieserDiagram
DemoMenuItem {
string Text
string Url
NavLinkMatch Match
}
InstallMenuEntries {
string Text
string Url
NavLinkMatch Match
}
DemoMenuItem ||--o| InstallMenuEntries : contains
%% The following entries were removed from InstallMenuEntries:
%% - WebAppBlazor (install-webapp)
%% - ServerBlazor (install-server)
%% - ClientBlazor (install-wasm)
%% - MauiBlazor (install-maui)
%% InstallMenuEntries now only contains 'Breakpoints' and 'GlobalOption'
Class diagram for removed Install component filesclassDiagram
class InstallContent {
}
class InstallContentRazorCs {
}
class Coms {
}
class ComsRazorCs {
}
class Install_Maui {
}
class Install_Server {
}
class Install_WebApp {
}
class Install_wasm {
}
InstallContent --|> InstallContentRazorCs
Coms --|> ComsRazorCs
%% All above classes/components were removed in this PR
Class diagram for updated Install.razor pageclassDiagram
class Install {
- IStringLocalizer<Install> Localizer
- IOptions<WebsiteOptions> WebsiteOption
+ Step-by-step install instructions (localized)
+ Tabbed code samples for different .NET versions
+ No longer injects PackageVersionService
- private string Version
- protected override async Task OnInitializedAsync()
}
File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey there - I've reviewed your changes - here's some feedback:
- Double-check that the step labels are correctly numbered and localized—there’s a duplicate “Step4” and no “Step5” in the new sequence.
- Verify that the
@@escaping in your Pre blocks renders the intended asset URLs correctly and doesn’t introduce Razor parsing issues. - Make sure removing the per-platform install pages and their menu entries doesn’t break existing routes or leave dangling navigation links.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Double-check that the step labels are correctly numbered and localized—there’s a duplicate “Step4” and no “Step5” in the new sequence.
- Verify that the `@@` escaping in your Pre blocks renders the intended asset URLs correctly and doesn’t introduce Razor parsing issues.
- Make sure removing the per-platform install pages and their menu entries doesn’t break existing routes or leave dangling navigation links.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
Pull Request Overview
This PR updates the installation documentation for BootstrapBlazor. The changes consolidate multiple platform-specific installation guides into a single, streamlined installation page with simplified instructions and better organization.
Key Changes:
- Replaced multiple platform-specific installation pages (Server, WebAssembly, MAUI) with a unified installation guide
- Simplified the installation steps with clearer, more concise instructions
- Removed obsolete localization entries and navigation menu items for removed pages
Reviewed Changes
Copilot reviewed 13 out of 25 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| zh-CN.json | Updated Chinese localization entries for the new unified installation documentation |
| en-US.json | Updated English localization entries for the new unified installation documentation |
| MenusLocalizerExtensions.cs | Removed navigation menu entries for deleted platform-specific installation pages |
| Install_wasm.razor | Deleted WebAssembly-specific installation page |
| Install_WebApp.razor | Deleted Web App installation page |
| Install_Server.razor | Deleted Server-specific installation page |
| Install_Maui.razor | Deleted MAUI-specific installation page |
| Install.razor | Replaced with new unified installation guide with tabbed content for different .NET versions |
| Coms.razor.css | Deleted unused component styles |
| Coms.razor.cs | Deleted unused component code-behind |
| Coms.razor | Deleted unused component file containing SVG/image references |
| InstallContent.razor.cs | Deleted shared installation content component code-behind |
| InstallContent.razor | Deleted shared installation content component markup |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7005 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 741 741
Lines 32397 32397
Branches 4485 4485
=========================================
Hits 32397 32397
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Link issues
fixes #7004
Summary By Copilot
Regression?
Risk
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Revamp the Install documentation to offer a streamlined, localized step-by-step guide with code samples and tabs for different .NET versions, and clean up obsolete pages, components, assets, and menu items
Enhancements:
Documentation:
Chores: