Skip to content

docs: API reference (docfx) #137

Description

@benaadams

Problem

No API documentation exists. Consumers need reference docs for all public types.

Sub-tasks

  • Add XML doc comments to all public types, methods, and properties
  • Configure docfx (or similar) to generate HTML API reference
  • CI step to build docs and catch missing XML comments
  • Host on GitHub Pages

Dependencies

Depends on: #108, #116, #128 (all public APIs should exist before documenting)
Unlocks: #138 (NuGet Source Link + XML docs)

Phase

Phase 4 (Polish & Release Readiness)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions