Skip to content

docs(mkdocs): migrate documentation portal to MkDocs, add D2 diagrams, bidirectional coverage links, and CI automation - #32

Merged
shashankch merged 1 commit into
mainfrom
docs/mkdocs-d2-site-and-docs-sync
Oct 3, 2026
Merged

shashankch merged 1 commit into
mainfrom
docs/mkdocs-d2-site-and-docs-sync

Conversation

@shashankch

@shashankch shashankch commented Oct 3, 2026 •

Copy link
Copy Markdown
Owner

Summary

Migrates the public documentation portal from legacy Docsify to Material for MkDocs, redraws 12 architecture diagrams using declarative D2 syntax with dark mode support, integrates bidirectional JaCoCo code coverage navigation, and adds automated CI/CD quality gates.

Key Changes

  • MkDocs Migration: Purged Docsify site files; configured Material for MkDocs with tabs, search, and dark/light theme switching.
  • D2 Architecture Diagrams: 12 modernized diagrams (docs/diagrams/*.d2 and SVGs) with offline vector icons and dark theme container styling fixes.
  • Coverage Navigation: Dedicated /coverage/ quality gates portal and /coverage-report/ interactive JaCoCo report with persistent back navigation.
  • CI/CD Quality Gates: Automated D2 diagram drift detection (./scripts/generate-diagrams.sh --check) and strict MkDocs build validation.

Verification

  • ./scripts/generate-diagrams.sh --check passed (zero drift across all 12 diagrams).
  • mkdocs build --strict passed (0 errors, 0 warnings).
  • All 12 SVG diagrams verified for dark mode rendering (0 hardcoded light fills).

…tion

- Migrate documentation portal from Docsify to Material for MkDocs
- Redraw 12 architectural diagrams in D2 with automated drift checks
- Add bidirectional JaCoCo coverage links and dark mode diagram styling
@shashankch
shashankch force-pushed the docs/mkdocs-d2-site-and-docs-sync branch from b6b6bc6 to 5551e7d Compare October 3, 2026 07:37
@shashankch
shashankch merged commit 3c6f378 into main Oct 3, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant