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 finishes the DocFX site rollout for
ModularityKit.Mutatorby turning the generated docs into a styled, navigable documentation site with package scoped API entry points, custom theme, and responsive layout.Highlights
DocFX site structure
index.mdand wire it into the DocFX build.Docs/API/API.mdandDocs/API/Redis.mdpages with generated API entry points.obj/api/core,obj/api/governance, andobj/api/redis.NamespaceDoccoverage for governance package roots so generated reference starts at the expected namespace surface.Custom theme and navigation
templates/modularitykit.API usability and responsive behavior
templates/modularitykit/styles/main.js.templates/modularitykit/styles/mobile.cssstylesheet.Why
Issue #52 started as API reference publishing from XML documentation, but the practical gap was larger than generation alone. Without a real homepage, package-scoped entry points, navigation that matched repository structure, and a usable mobile layout, the published output was technically generated but still not fit to serve as the repository docs site.
This PR makes the generated DocFX output usable as the primary documentation surface while keeping the source of truth in XML docs and Markdown already present in the repository.
Checks
docfx docfx.jsonCloses