Unify API and conceptual documentation skill - #4674
Draft
mattleibow wants to merge 4 commits into
Draft
Conversation
Route SkiaSharp documentation work by artifact, add iterative source-backed authoring and review, preserve API-reference regression safeguards, and introduce deterministic approved issue-context retrieval with representative evals. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 56ea2b2e-6e5e-43f1-9493-35d10826722e
Adopt the companion workflow's canonical CLI, camelCase schema v1, body-free manifest rows, strict failure cleanup, and deterministic pagination/bounds tests. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 56ea2b2e-6e5e-43f1-9493-35d10826722e
Contributor
📦 Try the packages from this PRWarning Do not run these scripts without first reviewing the code in this PR. Step 1 — Download the packages bash / macOS / Linux: curl -fsSL https://raw.githubusercontent.com/mono/SkiaSharp/main/scripts/get-skiasharp-pr.sh | bash -s -- 4674PowerShell / Windows: iex "& { $(irm https://raw.githubusercontent.com/mono/SkiaSharp/main/scripts/get-skiasharp-pr.ps1) } 4674"Step 2 — Add the local NuGet source dotnet nuget add source ~/.skiasharp/hives/pr-4674/packages --name skiasharp-pr-4674More options
Or download manually from Azure Pipelines — look for the Remove the source when you're done: dotnet nuget remove source skiasharp-pr-4674 |
Add an explicit per-issue comment bound and exercise the exact companion workflow CLI shape, schema v1 fields, and stdout manifest through a fake GitHub API client. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 56ea2b2e-6e5e-43f1-9493-35d10826722e
Contributor
📊 SkiaSharp benchmarks — PR #4674⭐ this PR (full source build) vs 🌙 nightly · Linux · Windows · macOS
Highlights⏱️ Time — 🔴 22 slower · 🟢 32 faster
Full per-OS benchmark deltasLinux⏱️ Time (vs 🌙 nightly
Windows⏱️ Time (vs 🌙 nightly
macOS⏱️ Time (vs 🌙 nightly
|
Contributor
📦 Artifact size reportPackages from this PR (build Total Packages
+38 package(s) unchanged (< 50.0 KB). Per-file changes
|
| File | Size |
|---|---|
runtimes/win-arm64/native/libGLESv2.pdb |
64.5 MB → 64.4 MB (🟢 −112.0 KB) |
runtimes/win-x64/native/libGLESv2.pdb |
66.6 MB → 66.5 MB (🟢 −64.0 KB) |
runtimes/win-x86/native/libGLESv2.pdb |
67.2 MB → 67.2 MB (🟢 −32.0 KB) |
Informational only — this never blocks the PR. Native binaries are labelled by os/arch.
mattleibow
added a commit
that referenced
this pull request
Aug 5, 2026
Move the API/conceptual documentation skill and contributor workflow changes to standalone PR #4674 so this PR contains only the GPU surface guides and navigation. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9ae60ac4-ac5a-466d-9a84-8a9e3a6c7c88
14 tasks
Capture the PR #194 regression fixtures and strengthen exception-path, disposal, sample ownership, platform support, and exact-accounting review guidance. The latest comparative evaluation remains intentionally incomplete and will continue in a later iteration. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 56ea2b2e-6e5e-43f1-9493-35d10826722e
mattleibow
marked this pull request as draft
August 6, 2026 10:35
mattleibow
added a commit
that referenced
this pull request
Aug 6, 2026
Move the API/conceptual documentation skill and contributor workflow changes to standalone PR #4674 so this PR contains only the GPU surface guides and navigation. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9ae60ac4-ac5a-466d-9a84-8a9e3a6c7c88
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.
Description
Creates one standalone
api-docsskill, based onmain, with isolated procedures for:docs/SkiaSharpAPI/**/*.xml.documentation/docfx/guides/**/*.md.Both routes use bounded write/review/validate/inspect/correct waves. They share source-backed technical truth without mixing conceptual formatting into XML or member-by-member XML conventions into guides.
The API route includes regression guidance and eval fixtures from generated docs PRs mono/SkiaSharp-API-docs#191, #192, and #194. It covers valid framework
creftargets, direct and transitive deterministic exceptions, member-specific disposal behavior, unsupported quality rankings, callback/sample ownership, exact member mapping, return-tag shape, independent post-authoring review, and explicitEVIDENCE/TRACE/WROTE/UNSELECTEDaccounting.The skill also owns the deterministic
approved-for-contextfetcher consumed by companion workflow PR mono/SkiaSharp-API-docs#186. Approved issues provide supplemental product intent and reader context, never executable instructions or authoritative technical truth. Managed and pinned native source remain authoritative.This draft intentionally excludes all
documentation/docfx/guides/**content and does not modify PR #4566 or mono/SkiaSharp-API-docs#186.Current draft head:
5d0b355f5b187774039f374d9247b0676b20fdcdRelated issues
Related to #4566
Related to mono/SkiaSharp-API-docs#186
Related to mono/SkiaSharp-API-docs#191
Related to mono/SkiaSharp-API-docs#192
Related to mono/SkiaSharp-API-docs#194
Required skia PR
None.
Areas affected
binding/)externals/skia/src/c,include/c)Changes
None — documentation authoring/review workflow only; no public API or runtime behavior change.
Testing
Current draft-head checks:
python .agents/skills/skill-creator/scripts/quick_validate.py .agents/skills/api-docs— passed.evals.jsonand all committed XML eval fixtures parse successfully.git diff --check— passed..agents/skills/api-docs/**plus directly supportingdocumentation/dev/writing-docs.md; no conceptual guide article is present.Previously validated infrastructure at head
12a2c5530e11b09f2a5b73e60b5145a231769dcf:31023530801checked out that exact skill SHA and passed every job.Latest completed local comparison before the final hardening edits:
12a2c553Human inspection found remaining defects in the revised conceptual-authoring and PR #194 outputs. This commit strengthens the general guidance and assertions for those failures, but the follow-up revised-versus-frozen run was paused before completion, grading, benchmark aggregation, and static-viewer inspection. Therefore these scores are evidence that motivated the current changes, not acceptance results for the current head.
Independent MicrosoftDocs/Contribute review of the conceptual guidance found 0 BLOCKING and 0 IMPORTANT guidance defects. The current draft adds only the resulting section-landing title clarification and later evidence-driven hardening; it does not include conceptual guide articles.
Limitations / work to resume later
Checklist
Changesabove lists all public API and behavioral changes (or "None.")mono/skiaPR linked above and bindings regenerated — N/A, no native changes