Skip to content

docs: add API reference publishing with DocFX#63

Merged
rian-be merged 1 commit into
mainfrom
issue-54-dependency-health
Jul 1, 2026
Merged

docs: add API reference publishing with DocFX#63
rian-be merged 1 commit into
mainfrom
issue-54-dependency-health

Conversation

@rian-be

@rian-be rian-be commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR replaces the hand-maintained API reference flow with DocFX so the public API docs are generated from XML documentation and stay aligned with the repo's current surface area.

Highlights

DocFX workflow

  • Add docfx.json and toc.yml to build the docs site repeatably.
  • Generate API reference output from the public packages' XML docs.
  • Keep the generated site under the existing Docs/API documentation structure.

Repo integration

  • Enable XML documentation output for the public packages that feed the reference.
  • Add a docs job to pr-check.yml and include it in validation-summary.
  • Document the DocFX build command in README.md.
  • Add /_site to .gitignore.

Cleanup

  • Fix XML doc warnings in IMutationEngine and MutationExecutor so the docs build stays clean.
  • Update Docs/API/Redis.md to point at the new reference entry page.
  • Replace the old hand-authored Docs/API/API-Reference.md with Docs/API/Reference.md.

Why

The previous API reference path was manual and easy to drift. DocFX gives us a repeatable generated reference from XML docs and keeps the output aligned with the existing Docs/API layout.

Checks

  • dotnet build ModularityKit.Mutator.slnx -c Release
  • git diff --check
  • docfx docfx.json in CI

Closes

@github-actions github-actions Bot added documentation Documentation updates and additions abstractions Public abstractions and contracts runtime Runtime implementation and execution flow ci CI/CD and repository automation changes performance Performance improvements or regressions labels Jul 1, 2026
@rian-be rian-be changed the title [codex] docs: switch API reference to DocFX docs: add API reference publishing with DocFX Jul 1, 2026
@rian-be rian-be self-assigned this Jul 1, 2026
@rian-be rian-be marked this pull request as ready for review July 1, 2026 18:50
@rian-be rian-be merged commit ed396fa into main Jul 1, 2026
30 of 31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

abstractions Public abstractions and contracts ci CI/CD and repository automation changes documentation Documentation updates and additions performance Performance improvements or regressions runtime Runtime implementation and execution flow

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Task]: Add API reference publishing from XML docs

1 participant