From 6333ec2229a7ab91b83d6c618ed8acb00034018a Mon Sep 17 00:00:00 2001 From: Gaurang Karia <204894819+gkaria@users.noreply.github.com> Date: Tue, 11 Nov 2025 10:13:21 +0000 Subject: [PATCH] docs: add explicit CALM validation instructions to architecture creation 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 #1793 --- calm-ai/tools/architecture-creation.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/calm-ai/tools/architecture-creation.md b/calm-ai/tools/architecture-creation.md index 64ec1e4a0..f14a1c30d 100644 --- a/calm-ai/tools/architecture-creation.md +++ b/calm-ai/tools/architecture-creation.md @@ -38,7 +38,13 @@ Every CALM architecture MUST include: - [ ] Add nodes array (even if empty initially) - [ ] Add relationships array to connect nodes - [ ] Include metadata array for operational info -- [ ] Validate against CALM schema before saving +**🚨 MANDATORY VALIDATION (Do not skip):** +- [ ] **Verify calm-cli is installed:** `which calm` +- [ ] **Run CALM validation:** `calm validate -a .architecture.json` +- [ ] **Review output for errors:** `jsonSchemaValidationOutputs`, `spectralSchemaValidationOutputs` +- [ ] **Fix ALL errors before proceeding** - Do not assume JSON validity equals CALM validity +- [ ] **Confirm output shows:** `"hasErrors": false, "hasWarnings": false` +- [ ] **Document any warnings addressed** ## Best Practices