Skip to content

Refactor diagram handling, enhance formats, and add SVG templates#28

Merged
gvreddy04 merged 4 commits into
mainfrom
features/architecture-diagram-updates
Jun 27, 2026
Merged

Refactor diagram handling, enhance formats, and add SVG templates#28
gvreddy04 merged 4 commits into
mainfrom
features/architecture-diagram-updates

Conversation

@gvreddy04

Copy link
Copy Markdown
Contributor

This pull request updates the devspec diagram and extract workflow to make SVG the default diagram output format (instead of Mermaid), and expands support for output format combinations to include svg, html, and mermaid in any non-duplicated combination. It also updates documentation, agent, and skill files to reflect these changes, clarifies how diagram input is parsed, and adds new intake patterns for architecture and other diagram families.

Diagram Output Format and Workflow Updates

  • Changed the default diagram output for /devspec.diagram and related commands from Mermaid to SVG, and updated all references and documentation to reflect this.

Diagram Input and Intake Pattern Enhancements

  • Added parsing and intake patterns for architecture diagrams and other diagram families, specifying how structured input fields are handled for each type.
  • Clarified that SVG and HTML diagrams must use the shared dark architecture-style visual contract unless a light or custom theme is explicitly requested.

Template and Artifact Handling

  • Updated SVG output handling to select templates based on diagram type, referencing the correct template for architecture, process-flow, sequence, state/lifecycle, domain-model, journey-map, timeline-plan, quadrant-analysis, and mindmap diagrams.
  • Ensured all generated SVG and HTML diagrams are consistent with the shared visual contract, including for custom or smaller SVGs.

Other Improvements

  • Improved instructions for handling required user input, output artifacts, and recovery behavior.
  • Updated agent and skill descriptions to match new defaults and supported output combinations.

These changes make the diagram generation workflow more flexible and consistent, improve clarity for users, and ensure better alignment with the intended visual standards.

- Updated artifact-queue.md to clarify storage locations for high-level diagram references, SVG images, optional Mermaid Markdown, and HTML artifacts.
- Revised diagram.md to specify the use of SVG as the default output and to include HTML as an optional format.
- Enhanced overview.md to reflect changes in diagram storage and output formats.
- Modified README.md files in diagrams, images, and html directories to provide clearer guidance on usage and generation rules.
- Introduced a new diagram.html template for generating standalone HTML diagrams with inline SVG support.
- Updated cli.py to classify HTML files as project-owned artifacts.
- Added tests to ensure proper handling of new HTML diagram artifacts and validate the standalone nature of generated HTML.
…agrams

- Created a new SVG file for a sequence diagram with customizable elements.
- Added a state lifecycle diagram SVG template with defined states and transitions.
- Introduced a timeline plan diagram SVG template featuring phases and milestones.
…tecture input and updating SVG template selection rules
…to visual contract

- Updated font-family in SVG and HTML templates to remove proprietary font fallbacks, ensuring compliance with the Apache-2.0 distribution guidelines.
- Ensured all generated SVG and HTML visual outputs follow the shared devspec dark visual contract, including background colors, text colors, and typography.
- Maintained consistency across various diagram templates including architecture, domain model, journey map, mindmap, process flow, sequence, state lifecycle, and timeline plan diagrams.
@gvreddy04 gvreddy04 added this to the 0.1.3 milestone Jun 27, 2026
@gvreddy04 gvreddy04 self-assigned this Jun 27, 2026
@gvreddy04 gvreddy04 added the enhancement New feature or request label Jun 27, 2026
@gvreddy04
gvreddy04 merged commit 79ef9de into main Jun 27, 2026
3 checks passed
@gvreddy04
gvreddy04 deleted the features/architecture-diagram-updates branch July 7, 2026 17:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant