Skip to content

Publish complete API documentation - #9

Merged
Stephanvs merged 5 commits into
mainfrom
feature/api-documentation
Aug 9, 2026
Merged

Publish complete API documentation#9
Stephanvs merged 5 commits into
mainfrom
feature/api-documentation

Conversation

@Stephanvs

@Stephanvs Stephanvs commented Aug 9, 2026

Copy link
Copy Markdown
Owner

What changed

  • documents the complete public API surface with XML comments
  • enables XML documentation generation without suppressing CS1591
  • explicitly disables MSTest parallelization because serialization tests change process-wide culture
  • publishes a final README covering the ordered model, typed features, multi-target package, safety model, CLI boundary, and roadmap
  • records only the intentional v2 API breaks in CompatibilitySuppressions.xml, while keeping baseline package validation active for any additional breaks

Validation

  • combined Release build across netstandard2.0, net8.0, and net10.0: 0 warnings, 0 errors
  • combined tests: 33/33 passed, including real D2 parser validation
  • generated XML documentation: valid and included for all three package assets
  • combined package validation against 1.0.0: passed with the checked-in intentional-v2 suppressions
  • .nupkg and .snupkg creation and content inspection: passed

Stack and merge order

Merge independent PR #6 first or at any point. Then merge #4; after that, #5 and #7 can be retargeted to main and merged in either order. Merge #8 next and retarget this PR to main last. Release the resulting API as 2.0.0 because the compatibility suppressions document intentional major-version changes.

@Stephanvs
Stephanvs changed the base branch from feature/typed-d2-features to main August 9, 2026 10:54
@Stephanvs
Stephanvs marked this pull request as ready for review August 9, 2026 10:54
@Stephanvs
Stephanvs merged commit 4c8e60d into main Aug 9, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant