Changelog

All notable changes to the UDE (Universal Documentation Engine) project will be documented in this file.

[v2.0] - 2026-07-08

The v2.0 milestone represents a comprehensive architectural overhaul, introducing strict typing, advanced decoupled CI/CD integrations, and enterprise-grade security gates.

Added

• Typed Entity Models: Complete schema evolution replacing untyped ClassEntity with 7 strict Pydantic models (e.g., VariableModel, MethodModel).
• Decoupled CLI Architecture: New subcommands ude parse, ude render, ude compile, and ude audit allowing discrete IR payload generation and rendering.
• Strict Coverage Auditing: GlobalConfig.coverage_mode and coverage_threshold settings, empowering the new ude audit blocking quality gate.
• Cross-Repository Orchestration: Formalized payload synchronization via GitHub repository_dispatch webhooks across the submodule topology.
• Automated Security Guards: pydantic_guard (Bash/PowerShell) to strictly block obsolete dictionary key access.
• Project Catalog Metadata: Added project_name and version fields to ProjectCatalog.

Changed

• Refactored fields: List[str] to fields: List[VariableModel].
• Enforced strict shell execution (bash -euo pipefail {0}) and minimized permissions in all GitHub Actions workflows.

---

[v1.0] - 2025-01-15

The initial MVP release establishing the core documentation generation capabilities.

Added

• Flat CLI flag architecture for single-pass documentation generation.
• Basic ClassEntity and NamespaceEntity string-keyed data structures.
• Support for Doxygen XML parsing and basic HTML/Markdown rendering output.

Related Docs: (Paths below are repository-root-relative.)

• user-docs/docs/migration-v2.md — step-by-step migration guide for the breaking changes listed above
• user-docs/docs/cli-reference.md — reference for the new ude parse/render/compile/audit subcommands