Regenerate frameworks docs: latest-only monikers#141
Merged
Conversation
Regenerated from the latest build output (SkiaSharp 4.150, HarfBuzzSharp 14.2) using the cleaned-up docs-format-docs pipeline: - Collapse from the old multi-version monikers (skiasharp-2.80 ... -4.147) to a single latest-only moniker per family (10 monikers total). - Collapse <AssemblyVersion> history to latest-only. - Drop docs for types/packages no longer built (Forms/UWP/watchOS views, GRBackendRenderTargetDesc, etc.), their ns-*.xml stubs, and stale index.xml <Assembly>/<Namespace> entries. Preserve the global ns-.xml stub. - Manually remove the one stale lingering member mdoc left behind (SKMatrix44.MapScalars(float,float,float,float), demoted public->internal). Net: 487 files, +9,496 / -93,247. Re-running the pipeline on this output is a no-op (idempotent). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
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 |
Contributor
|
Learn Build status updates of commit 9aaf615:
|
mattleibow
added a commit
that referenced
this pull request
Jun 19, 2026
Reset frameworks docs baseline to Windows-generated output (#142) Context: previous baseline #141 (regenerated on macOS) Depends-on: mono/SkiaSharp#4197 Generated-by: Auto API Docs Writer run 27798680653 (windows-latest) The prior baseline (#141) was regenerated on macOS, which corrupted the frameworks docs in two ways and made every later Windows run churn past the writer's 100-file PR cap: - A moniker filename collision in docs.cake let the GL-less MacCatalyst SkiaSharp.Views.iOS.dll clobber the richer net-iOS build, so mdoc --delete removed the real iOS GL types (SKGLView, SKGLLayer, SKPaintGLSurfaceEventArgs). Fixed upstream in mono/SkiaSharp#4197. - The macOS mono mdoc omitted [Nullable]/[NullableContext]/[IsReadOnly] attributes that the Windows mdoc.exe emits, and it stripped member structure. Each subsequent Windows regen re-added all of it, overflowing the create-pull-request file cap and blocking the docs pipeline. mdoc.exe is .NET Framework, so Windows is the only supported generation environment. This resets the baseline to the windows-latest CI output (aligned to current main, built with the #4197 fix) so future auto-api-docs-writer runs produce small, reviewable diffs. Changes (93 files): - Restore the iOS GL API docs dropped by the collision. - Normalize [Nullable]/[NullableContext]/[IsReadOnly] attributes to the Windows output. - Restore member structure stripped by the macOS regen (e.g. SKPaint grew from 1063 to 4388 lines). - Remove stale SkiaSharp.Views.Blazor.Internal ActionHelper and FloatFloatActionHelper docs; both types are guarded by #if !NET7_0_OR_GREATER and no longer exist in the shipped net7+ packages. No authored prose is lost: of 3140 written summary/remarks strings on main, the only 4 removed belong to the two deleted internal helper types. HarfBuzzSharp/HBColor.xml and SkiaSharp/SKWebpEncoderOptions.xml are deliberately left at their main content so the next generation run visibly re-processes them — proving the writer fills "To be added." placeholders (HBColor) and that structural regen re-adds attributes while preserving existing prose (SKWebpEncoderOptions). Co-authored-by: Matthew Leibowitz <mattleibow@live.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
mattleibow
added a commit
that referenced
this pull request
Jun 30, 2026
…, SKPaint text props) (#173) Resolve 36 xref-not-found build warnings caused by dangling <xref:> links in 2019-era hand-written remarks that point at members removed/relocated by the latest-only-monikers regeneration (#141). - Group 1 (24): remove obsolete pre-v1.68 DrawInSurface [!NOTE] blocks from the Apple Mac/iOS/tvOS SKCanvasLayer/SKCanvasView/SKGLLayer/SKGLView views. - Group 2 (4): drop obsolete ISKRenderer/SetRenderer [!NOTE] blocks from the Android SKGLSurfaceView/SKGLTextureView; surrounding prose already documents the modern OnPaintSurface/PaintSurface pattern. - Group 3 (4): repoint SKTypeface remarks from removed SKPaint text properties (TextSize/TextSkewX/TextScaleX/FakeBoldText) to their SKFont equivalents (Size/SkewX/ScaleX/Embolden) and fix the surrounding sentence. Unblocks Go Live PR #171. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
mattleibow
added a commit
that referenced
this pull request
Jun 30, 2026
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>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Regenerated the mdoc/XML frameworks docs from the latest build output (SkiaSharp 4.150, HarfBuzzSharp 14.2) using the cleaned-up
docs-format-docspipeline (SkiaSharp PR #4192).What changed
skiasharp-2.80...skiasharp-4.147,harfbuzzsharp-2.6...) down to a single latest-only moniker per family — 10 monikers total.<AssemblyInfo>now carries a single latest<AssemblyVersion>instead of the full accumulated history.GRBackendRenderTargetDesc, ...), their orphanns-*.xmlstubs, and staleindex.xml<Assembly>/<Namespace>entries. The globalns-.xmlstub is preserved.SKMatrix44.MapScalars(float,float,float,float)(demotedpublictointernal).Stats
487 files changed, +9,496 / -93,247(128 deleted, 359 modified, 12 new).Verification
index.xml: 28 to 22 assemblies (6 stale dropped), 0 empty namespaces.<AssemblyInfo>blocks, 0 with more than one version.