Skip to content

Commit d964ca3

Browse files
Merge pull request #1943 from markscott-ms/fix-day-13
fix(aoc): day 11 & 13 updates
2 parents dcc2d53 + 975a47a commit d964ca3

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

advent-of-calm/day-11.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,15 @@ A documentation website solves this by:
2323

2424
### 2. Generate Your Documentation Website
2525

26+
Please ensure your CALM CLI version is 1.22.1 or above. You can check your version with:
27+
28+
```bash
29+
calm --version
30+
```
31+
32+
Earlier versions have an issue with some links in the generated documentation website.
33+
34+
2635
```bash
2736
calm docify --architecture architectures/ecommerce-platform.json --output docs/generated/ecommerce-docs
2837
```

advent-of-calm/day-13.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Create a template that filters nodes by type - something the widgets don't do di
5757
---
5858
architecture: ../architectures/ecommerce-platform.json
5959
---
60-
# Node Inventory: {{name}}
60+
# Node Inventory: {{metadata.description}}
6161
6262
| Name | Type | ID | Description |
6363
|------|------|-------|-------------|
@@ -95,8 +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. Look for the "Live Docify Mode" badge in the status bar
99-
3. Open the CALM Preview to see filtered node lists
98+
2. Open the CALM Preview (Ctrl+Shift+C / Cmd+Shift+C) to see the rendered output
10099

101100
### 6. Create a Relationship Details Template
102101

@@ -108,7 +107,7 @@ Create a template that shows relationship details with custom formatting:
108107
---
109108
architecture: ../architectures/ecommerce-platform.json
110109
---
111-
# Relationship Details: {{name}}
110+
# Relationship Details: {{metadata.description}}
112111
113112
{{#each relationships}}
114113
### {{unique-id}}
@@ -170,7 +169,7 @@ You can mix calm-widgets with raw Handlebars in the same template:
170169
---
171170
architecture: ../architectures/ecommerce-platform.json
172171
---
173-
# {{name}} - Combined Documentation
172+
# {{metadata.description}} - Combined Documentation
174173
175174
## Architecture Overview (widget)
176175
{{block-architecture this}}

0 commit comments

Comments
 (0)