Skip to content

Commit 138b9ac

Browse files
Merge pull request #2018 from rocketstack-matt/feat/docs-learning-navigation
Integrate Advent of CALM into core docs
2 parents 834967b + 58f0e78 commit 138b9ac

25 files changed

Lines changed: 2025 additions & 476 deletions

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
.DS_Store
22

3+
# Sandbox folder for AI agent working files (not for check-in)
4+
/sandbox/
5+
36
# Docusaurus generated folders
47
website/translated_docs/
58
website/build/

AGENTS.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,22 @@
11
# FINOS CALM Monorepo - AI Assistant Guide
22

3+
## Sandbox Folder for Working Files
4+
5+
**IMPORTANT:** Use the `/sandbox/` folder for all temporary working files, test outputs, notes, and drafts.
6+
7+
- The `sandbox/` folder is in `.gitignore` and will not be committed
8+
- Store test plans, results, TODO lists, and exploration notes here
9+
- Do NOT create working files in other directories (they may accidentally be committed)
10+
- Clean up the sandbox when work is complete if appropriate
11+
12+
```bash
13+
# Example: Create working files in sandbox
14+
mkdir -p sandbox
15+
echo "My notes" > sandbox/my-notes.md
16+
```
17+
18+
---
19+
320
## Project Overview
421

522
This is the **FINOS Architecture as Code** monorepo containing the Common Architecture Language Model (CALM) specification and associated tools.

calm-ai/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Tool prompts should:
4040

4141
- Include critical validation requirements
4242
- Provide working examples
43-
- Reference CALM schema v1.0
43+
- Reference CALM schema v1.1
4444
- Emphasize common pitfalls and solutions
4545
- Follow consistent markdown formatting
4646

calm-ai/templates/CALM.chatmode_template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ CALM enables modeling of:
2121

2222
You specialize in helping users create, modify, and understand CALM architecture models. You have deep knowledge of:
2323

24-
- CALM schema validation requirements (release/1.0)
24+
- CALM schema validation requirements (release/1.1)
2525
- Best practices for architecture modeling
2626
- JSON schema constraints and validation rules
2727
- VSCode integration and tooling
@@ -40,7 +40,7 @@ On your first prompt in each session, you MUST:
4040

4141
## Guidelines
4242

43-
- Always validate CALM models against the 1.0 schema
43+
- Always validate CALM models against the 1.1 schema
4444
- Provide specific, actionable guidance for schema compliance
4545
- Reference the tool prompts for detailed creation instructions
4646
- Use examples that follow CALM best practices

calm-ai/tools/architecture-creation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Overview
44

5-
This guide provides instructions for creating complete CALM architecture documents that comply with the FINOS CALM v1.0 schema.
5+
This guide provides instructions for creating complete CALM architecture documents that comply with the FINOS CALM v1.1 schema.
66

77
## Required Schema Structure
88

@@ -31,7 +31,7 @@ Every CALM architecture MUST include:
3131

3232
## Architecture Creation Checklist
3333

34-
- [ ] Include required $schema reference to CALM v1.0
34+
- [ ] Include required $schema reference to CALM v1.1
3535
- [ ] Provide unique-id (kebab-case recommended)
3636
- [ ] Add descriptive name and description
3737
- [ ] Name file with `.architecture.json` suffix

calm-ai/tools/control-creation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## Official JSON Schema Definition
88

9-
The complete control schema from the FINOS CALM v1.0 specification:
9+
The complete control schema from the FINOS CALM v1.1 specification:
1010

1111
```json
1212
{

calm-ai/tools/flow-creation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## Official JSON Schema Definition
88

9-
The complete flow schema from the FINOS CALM v1.0 specification:
9+
The complete flow schema from the FINOS CALM v1.1 specification:
1010

1111
```json
1212
{

calm-ai/tools/interface-creation.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## Official JSON Schema Definition
88

9-
The complete interface schema from the FINOS CALM v1.0 specification:
9+
The complete interface schema from the FINOS CALM v1.1 specification:
1010

1111
```json
1212
{
@@ -199,4 +199,5 @@ Use **interface-type** when:
199199
2. Include all required properties for chosen type
200200
3. Port values must be integers, not strings
201201
4. URLs must be valid format
202-
5. No additional properties beyond those defined
202+
5. For `interface-definition`: no additional properties beyond `unique-id`, `definition-url`, and `config`
203+
6. For `interface-type`: any additional properties are allowed beyond `unique-id`

calm-ai/tools/metadata-creation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## Official JSON Schema Definition
88

9-
The complete metadata schema from the FINOS CALM v1.0 specification:
9+
The complete metadata schema from the FINOS CALM v1.1 specification:
1010

1111
```json
1212
{

calm-ai/tools/node-creation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Nodes represent the "boxes" in a typical architecture diagram and are the fundam
1919

2020
## Official JSON Schema Definition
2121

22-
The complete node schema from the FINOS CALM v1.0 specification:
22+
The complete node schema from the FINOS CALM v1.1 specification:
2323

2424
```json
2525
{

0 commit comments

Comments
 (0)