Skip to content

docs: DocFX site layout#66

Merged
rian-be merged 3 commits into
mainfrom
docfx-ui
Jul 1, 2026
Merged

docs: DocFX site layout#66
rian-be merged 3 commits into
mainfrom
docfx-ui

Conversation

@rian-be

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

Copy link
Copy Markdown
Contributor

Summary

This PR finishes the DocFX site rollout for ModularityKit.Mutator by 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

  • Ada real root homepage at index.md and wire it into the DocFX build.
  • Replace hand maintained Docs/API/API.md and Docs/API/Redis.md pages with generated API entry points.
  • Keep API output grouped by package under obj/api/core, obj/api/governance, and obj/api/redis.
  • Add NamespaceDoc coverage for governance package roots so generated reference starts at the expected namespace surface.

Custom theme and navigation

  • Add custom DocFX theme under templates/modularitykit.
  • Style the site with branded navigation, homepage sections, dark API surfaces, and package-aware active tabs.
  • Remove the homepage right-side contribution panel and let the center content use the full width.

API usability and responsive behavior

  • Add API sidebar behavior for expand/collapse and side panel toggling through templates/modularitykit/styles/main.js.
  • Split responsive rules into a dedicated templates/modularitykit/styles/mobile.css stylesheet.
  • Rework the mobile navbar into a usable stacked layout with a separate collapsed panel.
  • Normalize API page spacing and homepage layout so generated pages read consistently across desktop and mobile.

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.json

Closes

@github-actions github-actions Bot added documentation Documentation updates and additions architecture Design, structure, and API-shape changes labels Jul 1, 2026
@rian-be rian-be changed the title docs: polish DocFX site layout docs: DocFX site layout Jul 1, 2026
@rian-be rian-be merged commit 2eeb9b5 into main Jul 1, 2026
30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

architecture Design, structure, and API-shape changes documentation Documentation updates and additions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Task]: Add API reference publishing from XML docs

1 participant