You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|[Common Architecture Language Model](./calm)|[@rocketstack-matt](https://github.com/rocketstack-matt), [@jpgough-ms](https://github.com/jpgough-ms)|[](https://github.com/finos/architecture-as-code/actions/workflows/validate-spectral.yml)|
|[Common Architecture Language Model](./calm)|[@rocketstack-matt](https://github.com/rocketstack-matt), [@jpgough-ms](https://github.com/jpgough-ms), [@markscott-ms](https://github.com/markscott-ms)|[](https://github.com/finos/architecture-as-code/actions/workflows/validate-spectral.yml)|
|[CALM AI](./calm-ai)|[@rocketstack-matt](https://github.com/rocketstack-matt)| No build, prompt tools only, managed separately to CLI for easier maintenance and broader reuse. |
|[Docs](./docs)|[@rocketstack-matt](https://github.com/rocketstack-matt)|[](https://github.com/finos/architecture-as-code/actions/workflows/s3-docs-sync.yml)[](https://github.com/finos/architecture-as-code/actions/workflows/build-docs.yml)|
38
-
|[CALM VSCode Plugin](./calm-plugins/vscode)|[@LeighFinegold](https://github.com/LeighFinegold), [@rocketstack-matt](https://github.com/rocketstack-matt)||
38
+
|[CALM VSCode Plugin](./calm-plugins/vscode)|[@LeighFinegold](https://github.com/LeighFinegold), [@rocketstack-matt](https://github.com/rocketstack-matt), [@markscott-ms](https://github.com/markscott-ms)||
Copy file name to clipboardExpand all lines: advent-of-calm/day-12.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
# Day 12: Custom Documentation with CALM Widgets
2
2
3
3
## 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.
5
5
6
6
## Objective and Rationale
7
7
-**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
36
36
37
37
### 3. Create a Custom Template Using Widgets
38
38
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.
40
40
41
41
Create a file called `docs/architecture-summary.md` with the following content:
- Make sure you're in a CALM architecture file (has nodes/relationships)
203
203
- Try the keyboard shortcut: `Ctrl+Shift+C` / `Cmd+Shift+C`
204
204
- 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")
206
206
207
207
**"Changes aren't appearing in the preview"**
208
208
-**Save the file** - preview updates on save, not on every keystroke
0 commit comments