Skip to content

docs(doxygen): Standardize Doxygen configuration and GitHub Pages deployment across ecosystem #461

Description

@kcenon

What

Tracking epic for standardizing Doxygen configuration and GitHub Pages deployment across all 8 ecosystem libraries. Audit revealed 3 different workflow patterns, missing deployment pipeline, and inconsistent Doxyfile settings.

  • Current: 3 different workflow patterns (shared, inline, missing), Doxyfile settings vary in naming, versioning, and output format
  • Expected: All 8 libraries use the shared Doxygen workflow from common_system and consistent Doxyfile settings
  • Scope: .github/workflows/build-Doxygen.yaml and Doxyfile across all 8 repos

Why

  • pacs_system has no documentation pipeline: The largest library (310K+ LOC) has no GitHub Pages deployment
  • Workflow fragmentation: 5 libraries use shared workflow, 2 use custom inline, 1 has none — makes ecosystem-wide updates difficult
  • Visual inconsistency: Different PROJECT_NAME formats, missing version numbers, different diagram formats across GitHub Pages sites
  • Maintenance burden: Inline workflows diverge from the shared workflow over time (e.g., different checkout action versions)

Where

Workflow Status

Library Current Pattern Target
common_system ✅ Shared (self) No change
thread_system ✅ Shared No change
logger_system ✅ Shared + checkout-common-system No change
container_system ✅ Shared No change
monitoring_system ⚠️ Inline (50 lines) Migrate to shared
database_system ⚠️ Inline (custom) Migrate to shared
network_system ⚠️ Shared but missing PR trigger Add PR trigger
pacs_system ❌ No workflow Add shared workflow

How

Sub-Issues

Workflow Fixes

Doxyfile Standardization

Acceptance Criteria

  • All 8 libraries use the shared doxygen.yml workflow from common_system
  • All 8 libraries deploy to GitHub Pages on push to main
  • All 8 libraries validate Doxygen build on PRs
  • Doxyfile settings are consistent across all libraries
  • All GitHub Pages sites are accessible and visually consistent

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions