Summary
Add repeatable workflow for generating and publishing API reference documentation from the repository's XML docs.
Goal
Turn the existing XML documentation coverage into publishable API reference so the public surface of the library and its governance packages is easier to inspect and keep current.
Problem
The repository already has Docs/API/API.md and Docs/API/API-Reference.md, but the documentation workflow is still manual. As the public surface grows, manually keeping API docs in sync becomes error-prone and easy to postpone.
XML docs are already being enabled for test projects and are natural source of truth for public APIs. The missing piece is clear repo workflow that turns those docs into consistent reference artifact and keeps that artifact discoverable during local development and CI.
Scope
Design Expectations
- The workflow should source from XML docs rather than from hand maintained prose where possible.
- Generated reference content should be predictable and easy to review in diffs.
- The process should be simple enough to run locally before opening PR.
- The documentation layout should stay aligned with the current
Docs/API directory.
- If manual curation step is needed, it should be minimal and explicit.
Suggested Deliverables
- A documented API reference generation command
- Updated
Docs/API content produced from XML docs
- Clear instructions for contributors on when and how to regenerate the docs
- Optional CI validation that the reference is current
Acceptance Criteria
Non-Goals
- This issue does not redesign the docs site or docs theme
- This issue does not change runtime behavior
- This issue does not require every internal type to be documented publicly
- This issue does not force release packaging to depend on docs generation
Notes
This should be treated as documentation workflow issue, not code behavior change.
Summary
Add repeatable workflow for generating and publishing API reference documentation from the repository's XML docs.
Goal
Turn the existing XML documentation coverage into publishable API reference so the public surface of the library and its governance packages is easier to inspect and keep current.
Problem
The repository already has
Docs/API/API.mdandDocs/API/API-Reference.md, but the documentation workflow is still manual. As the public surface grows, manually keeping API docs in sync becomes error-prone and easy to postpone.XML docs are already being enabled for test projects and are natural source of truth for public APIs. The missing piece is clear repo workflow that turns those docs into consistent reference artifact and keeps that artifact discoverable during local development and CI.
Scope
Docs/APIstructureDesign Expectations
Docs/APIdirectory.Suggested Deliverables
Docs/APIcontent produced from XML docsAcceptance Criteria
Docs/APIstructureNon-Goals
Notes
This should be treated as documentation workflow issue, not code behavior change.