Skip to content

Commit 442872e

Browse files
Merge pull request finos#2093 from markscott-ms/2092-docs
docs(docs): fix references to CALM Tools extension
2 parents fdcc22e + caf731b commit 442872e

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

advent-of-calm/day-12.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Day 12: Custom Documentation with CALM Widgets
22

33
## Overview
4-
Learn about calm-widgets - a Handlebars-based widget framework for generating custom Markdown documentation from your CALM architecture data, using the VSCode CALM Preview.
4+
Learn about calm-widgets - a Handlebars-based widget framework for generating custom Markdown documentation from your CALM architecture data, using the VSCode CALM Tools extension.
55

66
## Objective and Rationale
77
- **Objective:** Understand how to use calm-widgets to create custom documentation templates
@@ -36,7 +36,7 @@ Review the available widgets in the [calm-widgets README](https://github.com/fin
3636

3737
### 3. Create a Custom Template Using Widgets
3838

39-
The easiest way to use calm-widgets is with the **VSCode CALM Preview**. Create a Markdown file with YAML front matter that specifies your architecture, and the preview will render the widgets live.
39+
The easiest way to use calm-widgets is with the **VSCode CALM Tools extension**. Create a Markdown file with YAML front matter that specifies your architecture, and the preview will render the widgets live.
4040

4141
Create a file called `docs/architecture-summary.md` with the following content:
4242

@@ -54,7 +54,7 @@ architecture: ../architectures/ecommerce-platform.json
5454

5555
**Understanding the Front Matter:**
5656

57-
The YAML front matter (between the `---` markers) tells the VSCode CALM Preview where to find your architecture data:
57+
The YAML front matter (between the `---` markers) tells the VSCode CALM Tools extension where to find your architecture data:
5858

5959
- `architecture:` - Path to your CALM architecture JSON file (relative to the template file)
6060
- `url-to-local-file-mapping:` (optional) - Path to a URL mapping file if your architecture references external schemas
@@ -156,7 +156,7 @@ git tag | grep -q "day-12"
156156

157157
- Start simple with `{{table nodes}}` and add options gradually
158158
- The `block-architecture` widget is powerful - experiment with `focus-flows` and `highlight-nodes`
159-
- Use the VSCode CALM Preview for instant feedback as you build templates
159+
- Use the VSCode CALM Tools extension for instant feedback as you build templates
160160
- Use `{{json-viewer data}}` to debug what data is available in your context
161161

162162
## Next Steps

advent-of-calm/day-13.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ architecture: ../architectures/ecommerce-platform.json
9595
Just like Day 12, you can preview this template in VSCode:
9696

9797
1. Open `templates/node-inventory.md` in VSCode
98-
2. Open the CALM Preview (Ctrl+Shift+C / Cmd+Shift+C) to see the rendered output
98+
2. Open the CALM preview pane (Ctrl+Shift+C / Cmd+Shift+C) to see the rendered output
9999

100100
### 6. Create a Relationship Details Template
101101

advent-of-calm/day-4.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The CALM VSCode extension gives you:
2222

2323
1. Open VSCode
2424
2. Go to Extensions (Ctrl+Shift+X / Cmd+Shift+X)
25-
3. Search for "CALM Preview & Tools"
25+
3. Search for "CALM Tools"
2626
4. Click **Install**
2727

2828
**Marketplace Link:** https://marketplace.visualstudio.com/items?itemName=FINOS.calm-vscode-plugin
@@ -202,7 +202,7 @@ git tag | grep -q "day-4"
202202
- Make sure you're in a CALM architecture file (has nodes/relationships)
203203
- Try the keyboard shortcut: `Ctrl+Shift+C` / `Cmd+Shift+C`
204204
- Look for the command in the Command Palette (`Ctrl+Shift+P` / `Cmd+Shift+P` , type "CALM")
205-
- If all else fails, you may need to restart the Extensions Host in VSCode (our CALM Preview is still in experimental mode and can be a little temperamental!) - (`Ctrl+Shift+P` / `Cmd+Shift+P` , type "Restart Extension Host")
205+
- If all else fails, you may need to restart the Extensions Host in VSCode (our CALM Tools extension is fairly new and can be a little temperamental!) - (`Ctrl+Shift+P` / `Cmd+Shift+P` , type "Restart Extension Host")
206206

207207
**"Changes aren't appearing in the preview"**
208208
- **Save the file** - preview updates on save, not on every keystroke

calm-plugins/sample-architecture/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This folder contains a set of CALM architecture files designed to test the featu
1515
"calm.urlMapping": "calm-plugins/sample-architecture/calm-mapping.json"
1616
```
1717
2. **Open Root**: Open `system.json`.
18-
3. **Preview**: Open the CALM Preview (`Ctrl+Shift+C` or Command Palette).
18+
3. **Preview**: Open the CALM preview pane (`Ctrl+Shift+C` or Command Palette).
1919
4. **Navigate**: Click the **Payment Service** node in the preview.
2020
- *Expected Behavior*: `payment-service.json` opens in the primary editor column, keeping the preview visible.
2121

docs/docs/tutorials/beginner/04-vscode-extension.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The CALM VSCode extension gives you:
3939

4040
1. Open VSCode
4141
2. Go to Extensions (`Ctrl+Shift+X` / `Cmd+Shift+X`)
42-
3. Search for "CALM Preview & Tools"
42+
3. Search for "CALM Tools"
4343
4. Click **Install**
4444

4545
**Marketplace Link:** https://marketplace.visualstudio.com/items?itemName=FINOS.calm-vscode-plugin

0 commit comments

Comments
 (0)