Document Svg.Editor.* Packages and Generated API#471
Merged
Conversation
This was referenced Mar 23, 2026
This was referenced Apr 6, 2026
This was referenced Apr 17, 2026
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
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.
PR Summary: Document
Svg.Editor.*Packages and Generated APIOverview
This PR adds full end-user documentation for the extracted editor package stack and wires those packages into the Lunet-generated API site.
The repository already contains the reusable editor implementation under
src/Svg.Editor.*. This PR makes that surface discoverable and maintainable by:Editorarticle section to the docs site,api.dotnetgeneration to include allSvg.Editor.*projects,docs/editor-packages.mdfile to a short maintainer-oriented note and pointing readers at the canonical site docs.Commit Breakdown
1.
a78e4f46Add editor docs articles and package guidesAdds the authored documentation content for the editor stack.
Included:
site/articles/editor/section:readme.mdarchitecture.mdembedding-workspace.mdcomposing-panels-and-dialogs.mdrendering-and-svg-services.mdsite/articles/packages/svg-editor-core.mdsite/articles/packages/svg-editor-svg.mdsite/articles/packages/svg-editor-skia.mdsite/articles/packages/svg-editor-avalonia.mdsite/articles/packages/svg-editor-skia-avalonia.mdsite/articles/menu.ymlsite/articles/packages/menu.ymlsite/articles/packages/readme.mdsite/articles/readme.mdsite/readme.mdsite/articles/getting-started/overview.mdsite/articles/concepts/package-architecture.mdKey content added:
Svg.Editor.Core,Svg.Editor.Svg,Svg.Editor.Skia,Svg.Editor.Avalonia, andSvg.Editor.Skia.AvaloniaSvgEditorWorkspace,SvgEditorSurface,DialogService,FileDialogService,PreviewRequested,ResourceAssembly, andWorkspaceTitlePrefixReview fixes folded into the authored docs:
SvgEditorSurfacecomes fromSvg.Editor.Skia.Avalonia, notSvg.Editor.Avaloniaby itself2.
da16b05dDocument editor API generation and referencesExtends the generated API documentation and its supporting reference docs.
Included:
site/config.scribansite/articles/reference/api-coverage-index.mdsite/articles/reference/lunet-docs-pipeline.mdsite/articles/reference/packages-and-namespaces.mdKey changes:
Svg.Editor.*projects to Lunetapi.dotnet.projectsAvalonia.Controls.ColorPickerAvalonia.Controls.DataGrid/apisite explicitly lists the editor assembliessrc/3.
108a486aRefresh editor package maintainer noteUpdates
docs/editor-packages.mdto stop serving as the primary user-facing documentation source.Changes:
SvgEditorWorkspaceDocumentation Structure After This PR
New user-facing editor docs
site/articles/editor/site/articles/packages/svg-editor-*.mdUpdated cross-reference/docs plumbing
site/config.scribansite/articles/reference/api-coverage-index.mdsite/articles/reference/lunet-docs-pipeline.mdsite/articles/reference/packages-and-namespaces.mdUpdated entry points
site/readme.mdsite/articles/readme.mdsite/articles/getting-started/overview.mdsite/articles/concepts/package-architecture.mdsite/articles/packages/readme.mdValidation
Ran successfully:
./build-docs.sh dotnet format --no-restore dotnet build Svg.Skia.slnx -c Release dotnet test Svg.Skia.slnx -c Release --no-buildNotes:
Svg.Editor.*projects.dotnet buildstill reports the repository's existing warnings, including the knownNU1510warning insamples/svgcand existing nullable/obsolete API warnings elsewhere.Reviewer Focus
api.dotnetproject list is the intended long-term surface for the generated API site.SvgEditorWorkspaceconsumers versus custom-shell consumers.