This release significantly expands the application's content management capabilities by introducing a new 'Release Notes' section for product updates and enhancing the existing help documentation system. It ensures the quality and discoverability of help content through new validation tools and improved content loading mechanisms. Additionally, it refactors a common UI component for diagram loading and updates database migration records to reflect recent schema changes.
Highlights
- New Release Notes Feature: A dedicated section (/changelog) has been introduced to display product updates, complete with individual release note pages, dynamic routing, and metadata generation. This includes new files for the changelog index, individual articles, and a dedicated layout.
- Enhanced Help Content System: A robust validation script (
npm run validate:help) has been implemented for Markdown front matter in help documentation. This ensures data integrity, checks for required fields and duplicate keys, and improves content loading logic to support slug fields and recursive file scanning. - Refactored Diagram Loading Overlay: The diagram loading UI has been extracted into a reusable
LoadingDiagramOverlaycomponent, improving code modularity and maintainability across different diagram list sections. - Updated Help Documentation Structure: Existing help Markdown files have been standardized by adding slug and subcategory fields to their front matter, improving content organization and URL consistency. New internal documentation (
docs/help-content-system.md) details this system. - New Release Note Content: Several new Markdown files have been added under
content/release-notes/detailing recent development updates, covering topics like diagram version control, template scopes, UI preferences, and terminology updates.