Skip to content
Anomaly

API and Namespace Index

Intended scope

Section titled “Intended scope”
  • Approach — publish an index generated from XML doc comments across Anomaly.Client.Api.
  • Candidate generators to evaluate:
    • DocFX (static, mature, Markdown-friendly).
    • xmldoc2md (lightweight, emits MDX-compatible Markdown).
    • Custom Roslyn walker (full control).
  • Output layout — one page per namespace, anchor per type, method tables with parameter summaries.
  • Wiring into the Starlight sidebar — either an autogenerated subdirectory under reference/api/ or a top-level /api/ route.
  • Rebuild cadence — on each tagged release of Anomaly.Client.Api.

Sources

Section titled “Sources”
  • Anomaly.Client.Api\ — XML-doc-documented public API (confirmed consistent coverage in exploration).
  • E:\Projects\AnomalyLabs\Anomaly\AGENTS.md — repo build conventions.