Reset frameworks docs baseline to Windows-generated output#142
Conversation
Regenerated on the windows-latest CI runner (Auto API Docs Writer run 27798680653) using the docs.cake moniker-collision fix (mono/SkiaSharp#4197), aligned to current main. This establishes a clean, Windows-consistent baseline so future auto-api-docs-writer runs produce small, reviewable diffs that stay under the create-pull-request file cap. Changes (95 files): - Restore iOS GL API docs (SKGLView, SKGLLayer, SKPaintGLSurfaceEventArgs) that the moniker filename collision had dropped. - Normalize [Nullable]/[NullableContext]/[IsReadOnly] attributes that the macOS mono mdoc run had omitted. - Restore member structure stripped by the prior macOS regeneration. - Remove stale SkiaSharp.Views.Blazor.Internal ActionHelper / FloatFloatActionHelper docs; these types are guarded by #if !NET7_0_OR_GREATER and no longer exist in the shipped net7+ packages. All authored documentation prose is preserved: of 3140 written summary/remarks strings on main, the only 4 removed belong to the two deleted internal helper types above. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit ff3f51e:
|
Leave these two files at their current main content so a follow-up auto-api-docs-writer run visibly re-processes them, verifying the generation does real work: - HarfBuzzSharp/HBColor.xml has 58 "To be added." placeholders, so the writer must fill them with authored prose. - SkiaSharp/SKWebpEncoderOptions.xml is already fully documented, so the run must re-add the structural [IsReadOnly]/[Nullable] attributes while preserving the existing prose. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit 088c4d2:
|
Go Live: publish latest API docs (#171) Publish the accumulated SkiaSharp / HarfBuzzSharp API documentation from main to the live (published) branch. This is the first Go Live since #66 and rolls up a large batch of docs automation, a full regeneration, and content/cross-reference cleanup. Highlights in this batch: - Docs automation: automated API docs writer (#92, hardened in #155), daily update workflow, go-live workflow (#65), and a Learn Build status-based auto-merge gate (#82, #83) backed by check-learn-build.py and a .github/known-warnings.csv baseline. - Regeneration: frameworks docs switched to latest-only monikers (#141), baseline reset to the Windows-generated output (#142), and stub regeneration moved to Linux via Mono (#147). This drops older, no-longer-shipping member/type pages (e.g. pre-v1.68 view APIs, the removed Android ISKRenderer interface, and the SKPaint text properties that moved to SKFont). - Content: filled API documentation placeholders (#150, #151, #172) and fixed broken cross-references (#152). - Cross-reference cleanup (#173): removed/repointed 36 obsolete xref-not-found references left behind by the latest-only-moniker regeneration — dangling links in 2019-era remarks to members that were since removed or relocated. Without this the Go Live build reported 160 warnings and the auto-merge gate (correctly) blocked the publish. Build health at publish: 0 errors, 124 warnings, 0 suggestions. All 124 remaining warnings are expected xref-not-found references to external framework types (OpenTK, Gdk/Cairo/Graphene, ElmSharp/Tizen.NUI, Windows.UI.Xaml, Microsoft.UI.Xaml, SharpVk, Vortice) that Learn cannot resolve and which are tracked in the known-warnings.csv baseline — 0 new warnings versus baseline, so the gate passes. Co-authored-by: Matthew Leibowitz <mattleibow@live.com> Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 participant
Why
The previous baseline (#141) was regenerated on macOS, which introduced two problems and a lot of downstream churn:
docs.cakelet the GL-less MacCatalystSkiaSharp.Views.iOS.dllclobber the richer net-iOS build, somdoc --deleteremovedSKGLView,SKGLLayer, andSKPaintGLSurfaceEventArgs. Fixed by Fix docs.cake moniker collision dropping iOS GL API docs SkiaSharp#4197.mdocomitted[Nullable]/[NullableContext]/[IsReadOnly]attributes that the Windowsmdoc.exeemits, so every subsequent Windows regen re-added them and blew past the writer's 100-file PR cap.This PR resets the baseline to the Windows CI output (the only supported generation environment —
mdoc.exeis .NET Framework), so futureauto-api-docs-writerruns produce small, reviewable diffs.What changed (95 files)
SKGLView,SKGLLayer,SKPaintGLSurfaceEventArgs).[Nullable]/[NullableContext]/[IsReadOnly]attributes to the Windows output.SkiaSharp.Views.Blazor.Internal.ActionHelper/FloatFloatActionHelper(3 files) — these types are guarded by#if !NET7_0_OR_GREATERand do not exist in the shipped net7+ packages.Safety
main, only 4 are removed — all belonging to the two deleted internal helper types above.windows-latestfrom Auto API Docs Writer run 27798680653, checked out against SkiaSharp branchmattleibow/fluffy-potato(the #4197 fix), aligned to currentmain.Depends on mono/SkiaSharp#4197 landing so scheduled runs keep producing this baseline.
Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com