docs: add explicit CALM validation instructions to chat mode #1795
Merged
markscott-ms merged 2 commits intofinos:mainfrom Nov 11, 2025
Merged
docs: add explicit CALM validation instructions to chat mode #1795markscott-ms merged 2 commits intofinos:mainfrom
markscott-ms merged 2 commits intofinos:mainfrom
Conversation
…ion guide The architecture-creation guide previously included a checklist item for validation but lacked actual instructions on how to perform it. This created inconsistency with other CALM guides (pattern-creation.md, documentation-creation.md) that include explicit validation commands. Add comprehensive validation steps including: - calm validate command with proper syntax - Clear success criteria (hasErrors: false, hasWarnings: false) - Guidance to review and fix errors before proceeding - Instructions to document any warnings addressed Fixes finos#1793
jpgough-ms
approved these changes
Nov 11, 2025
pmerrison
pushed a commit
to pmerrison/architecture-as-code
that referenced
this pull request
Nov 20, 2025
docs: add explicit CALM validation instructions to chat mode
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
3 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
This PR adds explicit CALM schema validation instructions to the Architecture Creation Guide, resolving a documentation gap in chat mode to mandate validation of architecture json files.
Problem
The architecture-creation guide included a validation checklist item but provided no actual instructions on how to perform validation. This was inconsistent with other CALM creation guides and left agent unclear about which command to run or how to interpret results.
Solution
Added a MANDATORY VALIDATION section to the checklist that includes:
calm validatecommand syntaxChanges
calm validate -a <filename>.architecture.jsonhasErrors: false, hasWarnings: false)Testing
Related Issue
Fixes #1793
Checklist