docs: add API reference publishing with DocFX#63
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
docfx.jsonandtoc.ymlto build the docs site repeatably.Docs/APIdocumentation structure.Repo integration
docsjob topr-check.ymland include it invalidation-summary.README.md./_siteto.gitignore.Cleanup
IMutationEngineandMutationExecutorso the docs build stays clean.Docs/API/Redis.mdto point at the new reference entry page.Docs/API/API-Reference.mdwithDocs/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/APIlayout.Checks
dotnet build ModularityKit.Mutator.slnx -c Releasegit diff --checkdocfx docfx.jsonin CICloses