Skip to content

docs: add explicit CALM validation instructions to chat mode #1795

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
markscott-ms merged 2 commits into from
Nov 11, 2025
Merged

docs: add explicit CALM validation instructions to chat mode #1795

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6333ec2
docs: add explicit CALM validation instructions to architecture creat…
gkaria Nov 11, 2025
5bbef53
Merge branch 'main' into docupdates
gkaria Nov 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion calm-ai/tools/architecture-creation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <filename>.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

Expand Down
Loading