Skip to content

Commit de915d2

Browse files
docs: Fix typos, incorporate reviewer comments
1 parent 07e3912 commit de915d2

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/docs/tutorials/build-a-calm-architecture/define-initial-architecture.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Ran terminal command: cat > "trading-system.architecture.json" << 'EOF'
4040
EOF
4141
4242
43-
Now let me validate the architecture file to ensure it's compliant with CALM v1.1:
43+
Now let me validate the architecture file to ensure it's compliant with CALM v1.2:
4444
4545
Ran terminal command: calm validate -a trading-system.architecture.json
4646
@@ -218,7 +218,7 @@ one account and one security. Positions aggregate trades for the same
218218
security within an account to provide a consolidated view of holdings.
219219
```
220220

221-
**Response from AI Assitant**
221+
**Response from AI Assistant**
222222
```text
223223
Based on the business design, here are the candidate CALM nodes for this event-driven architecture:
224224
@@ -269,9 +269,9 @@ Based on the business design, here are the candidate CALM nodes for this event-d
269269
These nodes capture all the components mentioned in the business design that participate in the event-driven workflows described.
270270
```
271271

272-
_Note_: Reviewing content is a guardrail to help ensure the AI Assistant does not stray from the architect intent.
272+
_Note_: Reviewing content is a guardrail to help ensure the AI Assistant does not stray from the architect's intent.
273273

274-
## Review candiate relationships defined in the business design
274+
## Review candidate relationships defined in the business design
275275

276276

277277
**Prompt to AI Assistant**
@@ -378,7 +378,7 @@ The architecture has been validated successfully with no errors or warnings.
378378
Made changes.
379379
```
380380

381-
_Note_: Whenever an update is made to the architecture file, the `calm validate` command should be used to ensure syntatic correctness. If the AI Assistant does not run it, the architect should request it to be run.
381+
_Note_: Whenever an update is made to the architecture file, the `calm validate` command should be used to ensure syntactic correctness. If the AI Assistant does not run it, the architect should request it to be run.
382382

383383
### Excerpt of the CALM Architecture JSON
384384
![Raw Architecture JSON](./images/00_initial_architecture_json.png)
@@ -389,7 +389,7 @@ _Note_: Whenever an update is made to the architecture file, the `calm validate
389389
Review the updated architecture file content. If any issues are detected, prompt the AI Assistant or manually update the JSON file for corrections.
390390

391391
### Preview of the Overall Architecture
392-
![Overall Architecturee](./images/01_initial_architecture_overall_preview.png)
392+
![Overall Architecture](./images/01_initial_architecture_overall_preview.png)
393393

394394
### Preview of Trade Service
395395
![Trade Service](./images/02_initial_architecture_trade_service_preview.png)
@@ -399,7 +399,7 @@ Review the updated architecture file content. If any issues are detected, promp
399399

400400
## Commit Architecture to GIT repo
401401

402-
Another good practice is to commit the architecture json file after signficant updates. The AI Assistant can help you with this task.
402+
Another good practice is to commit the architecture json file after significant updates. The AI Assistant can help you with this task.
403403

404404
**Prompt to AI Assistant**
405405
```text
@@ -566,7 +566,7 @@ Ran terminal command: git add trading-system.architecture.json && git commit -m
566566
Committed successfully with message "add initial flow definitions".
567567
```
568568

569-
## Review process flows with CALM Tool VSCode extesion
569+
## Review process flows with CALM Tool VSCode extension
570570

571571
_Note_: For purposes of this tutorial, only two process flows are reviewed. In actual work, all process flows should be reviewed for completeness and accuracy.
572572

@@ -675,7 +675,7 @@ At this point the architect has completed the initial definition of the architec
675675

676676
**Prompt to AI Assistant**
677677
```text
678-
git commit architecture file with mesasge "revised trade-submit and process-trade flows"
678+
git commit architecture file with message "revised trade-submit and process-trade flows"
679679
```
680680

681681
**Response from AI Assistant**

0 commit comments

Comments
 (0)