Skip to content

Commit 5191359

Browse files
csharpfritzCopilot
andauthored
Feature/docs strict build fix upstream dev (FritzAndFriends#563)
* fix: Documentation build issues — add missing nav entries and fix broken links - Add Migration/InlineCSharp.md to mkdocs.yml nav (was missing from documentation index) - Fix BWFC022.md reference to ClientScriptMigrationGuide (simplify to direct link) - Remove TODO image reference in Analyzers.md (bwfc025-warning-squiggle.png not needed for v1.0.0) - All mkdocs build warnings now cleared in strict mode Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: fix ClientScriptMigrationGuide anchor links for strict build - Correct BWFC022 cross-file anchor to ClientScriptMigrationGuide heading - Correct internal anchor link in ClientScriptMigrationGuide - Keep mkdocs --strict build green in CI Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent f1fc9fa commit 5191359

4 files changed

Lines changed: 49 additions & 43 deletions

File tree

docs/Analyzers/BWFC022.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@ This analyzer warns when your code uses `Page.ClientScript` or `ClientScriptMana
2020

2121
---
2222

23+
## Recommended Solution
24+
25+
**Use the ClientScriptShim for zero-code rewrite** — See [ClientScript Migration Guide](../Migration/ClientScriptMigrationGuide.md) for details on the easiest migration path that requires no code changes.
26+
27+
---
28+
2329
## Example
2430

2531
```csharp
@@ -63,7 +69,7 @@ Page.ClientScript.RegisterStartupScript(GetType(), "init", "...", true);
6369
ClientScript.RegisterStartupScript(GetType(), "init", "...", true);
6470
```
6571

66-
See ["ClientScriptShim (Zero-Rewrite Path)"](../Migration/ClientScriptMigrationGuide.md#-recommended-clientscriptshim-zero-rewrite-path) in the migration guide for details.
72+
See ["ClientScriptShim (Zero-Rewrite Path)"](../Migration/ClientScriptMigrationGuide.md#recommended-clientscriptshim-zero-rewrite-path) in the migration guide for details.
6773

6874
---
6975

docs/Migration/Analyzers.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -793,7 +793,6 @@ This analyzer does not have an automatic code fix because the correct replacemen
793793

794794
<!-- TODO: Add Visual Studio screenshot showing BWFC025 Warning squiggle on ViewState assignment with DataTable -->
795795
<!-- Screenshot should show: the yellow warning squiggle under the assignment, tooltip showing "ViewState assignment stores 'System.Data.DataTable' which may not be JSON-serializable" -->
796-
![BWFC025 Warning squiggle in Visual Studio](../images/analyzers/bwfc025-warning-squiggle.png){ .analyzer-screenshot }
797796

798797
---
799798

docs/Migration/ClientScriptMigrationGuide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ protected override void OnInitialized()
193193
}
194194
```
195195

196-
See [ClientScriptShim (Zero-Rewrite Path)](#-recommended-clientscriptshim-zero-rewrite-path) above for full details.
196+
See [ClientScriptShim (Zero-Rewrite Path)](#recommended-clientscriptshim-zero-rewrite-path) above for full details.
197197

198198
### Alternative Approach: Modern IJSRuntime Rewrite
199199

mkdocs.yml

Lines changed: 41 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -196,46 +196,47 @@ nav:
196196
- WebFormsPage: UtilityFeatures/WebFormsPage.md
197197
- WebFormsForm: UtilityFeatures/WebFormsForm.md
198198
- Migration:
199-
- Getting Started: Migration/readme.md
200-
- Quick Start Guide: Migration/QuickStart.md
201-
- Three-Layer Methodology: Migration/Methodology.md
202-
- Control Coverage: Migration/ControlCoverage.md
203-
- Strangler Fig Pattern: Migration/StranglerFigPattern.md
204-
- Phase 1 - Compilation Shims:
205-
- ConfigurationManager: Migration/Phase1-ConfigurationManager.md
206-
- App_Start Stubs: Migration/Phase1-AppStartStubs.md
207-
- Phase 2 - Runtime Shims:
208-
- Session State: Migration/Phase2-SessionShim.md
209-
- Page Lifecycle: Migration/Phase2-LifecycleTransforms.md
210-
- Event Handler Signatures: Migration/Phase2-EventHandlerSignatures.md
211-
- Assess:
212-
- Migration Readiness Assessment: Migration/migration_readiness.md
213-
- Deprecation Guidance: Migration/DeprecationGuidance.md
214-
- Known Fidelity Divergences: MigrationGuides/KnownFidelityDivergences.md
215-
- Plan:
216-
- Migration Strategies: Migration/Strategies.md
217-
- .NET Standard to the Rescue: Migration/NET-Standard.md
218-
- Automated Migration Guide: Migration/AutomatedMigration.md
219-
- Automated Migration with Copilot: Migration/AutomatedMigrationWithCopilot.md
220-
- Roslyn Analyzers: Migration/Analyzers.md
221-
- Guides:
222-
- ClientScript Migration: Migration/ClientScriptMigrationGuide.md
223-
- Implement:
224-
- Master Pages: Migration/MasterPages.md
225-
- User Controls: Migration/User-Controls.md
226-
- Custom Controls: Migration/Custom-Controls.md
227-
- Custom Control Base Classes: Migration/CustomControl-BaseClasses.md
228-
- Custom WebControl (RenderContents): Migration/CustomWebControl.md
229-
- FindControl Migration: Migration/FindControl-Migration.md
230-
- Deferred Controls: Migration/DeferredControls.md
231-
- Themes and Skins: Migration/ThemesAndSkins.md
232-
- Migrating .ashx Handlers: Migration/MigratingAshxHandlers.md
233-
- Copilot Skills (AI-Assisted):
234-
- Overview: Migration/CopilotSkills/Overview.md
235-
- Core Migration: Migration/CopilotSkills/CoreMigration.md
236-
- Identity & Auth: Migration/CopilotSkills/IdentityMigration.md
237-
- Data & Architecture: Migration/CopilotSkills/DataMigration.md
238-
- Migration Checklist Template: Migration/ChecklistTemplate.md
199+
- Getting Started: Migration/readme.md
200+
- Quick Start Guide: Migration/QuickStart.md
201+
- Three-Layer Methodology: Migration/Methodology.md
202+
- Control Coverage: Migration/ControlCoverage.md
203+
- Strangler Fig Pattern: Migration/StranglerFigPattern.md
204+
- Phase 1 - Compilation Shims:
205+
- ConfigurationManager: Migration/Phase1-ConfigurationManager.md
206+
- App_Start Stubs: Migration/Phase1-AppStartStubs.md
207+
- Phase 2 - Runtime Shims:
208+
- Session State: Migration/Phase2-SessionShim.md
209+
- Page Lifecycle: Migration/Phase2-LifecycleTransforms.md
210+
- Event Handler Signatures: Migration/Phase2-EventHandlerSignatures.md
211+
- Assess:
212+
- Migration Readiness Assessment: Migration/migration_readiness.md
213+
- Deprecation Guidance: Migration/DeprecationGuidance.md
214+
- Known Fidelity Divergences: MigrationGuides/KnownFidelityDivergences.md
215+
- Plan:
216+
- Migration Strategies: Migration/Strategies.md
217+
- .NET Standard to the Rescue: Migration/NET-Standard.md
218+
- Automated Migration Guide: Migration/AutomatedMigration.md
219+
- Automated Migration with Copilot: Migration/AutomatedMigrationWithCopilot.md
220+
- Roslyn Analyzers: Migration/Analyzers.md
221+
- Guides:
222+
- ClientScript Migration: Migration/ClientScriptMigrationGuide.md
223+
- Inline C# Forms: Migration/InlineCSharp.md
224+
- Implement:
225+
- Master Pages: Migration/MasterPages.md
226+
- User Controls: Migration/User-Controls.md
227+
- Custom Controls: Migration/Custom-Controls.md
228+
- Custom Control Base Classes: Migration/CustomControl-BaseClasses.md
229+
- Custom WebControl (RenderContents): Migration/CustomWebControl.md
230+
- FindControl Migration: Migration/FindControl-Migration.md
231+
- Deferred Controls: Migration/DeferredControls.md
232+
- Themes and Skins: Migration/ThemesAndSkins.md
233+
- Migrating .ashx Handlers: Migration/MigratingAshxHandlers.md
234+
- Copilot Skills (AI-Assisted):
235+
- Overview: Migration/CopilotSkills/Overview.md
236+
- Core Migration: Migration/CopilotSkills/CoreMigration.md
237+
- Identity & Auth: Migration/CopilotSkills/IdentityMigration.md
238+
- Data & Architecture: Migration/CopilotSkills/DataMigration.md
239+
- Migration Checklist Template: Migration/ChecklistTemplate.md
239240
- Analyzers:
240241
- BWFC022: Analyzers/BWFC022.md
241242
- BWFC023: Analyzers/BWFC023.md

0 commit comments

Comments
 (0)