Add compile command, require to compile .mmd#1
Open
andywangyzfh wants to merge 2 commits into
Open
Conversation
andywangyzfh
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Introduces a new Compile command that exports existing technical design artifacts into a human-readable technical design document under assets/exports/.
Enhances the design workflow to validate Mermaid diagram syntax and fix errors before presenting diagrams to the user.
Details
New resources/commands/archie-compile.yaml command reads design artifacts (features/, workflow/, api/, storage.md, metrics.md, dependency.md, background.md, glossary.md) and synthesizes them into a structured technical design document focused on readability, not copy-paste.
The generated document follows a standard structure (Overview, Requirements, Architecture, Workflow, API Design, Data Model, Metrics & Monitoring, Dependencies, Open Questions) with clear guidelines and guard checks on feature status and required artifacts.
Updates resources/commands/archie-design.yaml to add a validation step for Mermaid diagrams, require both flowchart and sequence diagrams, and ensure syntax errors are fixed before diagrams are shown to the user.
Motivation
Makes it easier for engineers and stakeholders to consume designs without digging through multiple raw files or code.
Improves reliability of generated diagrams by catching and correcting Mermaid syntax issues early in the interactive design flow.
Testing
Ran archie-design to generate diagrams and verified that syntax validation and error-fix behavior run before user approval.
Ran archie-compile on an existing design and confirmed the output assets/exports/tech-design-*.md is generated with the expected structure and content transformation.