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
docs(calm-suite): instruct npm usage instead of pnpm in calm-guard docs
Address review feedback on #2407: update calm-guard README, AGENTS.md, and the
Docusaurus docs site (getting-started, contributing, getting-started, security,
api/reference, architecture/system-overview, uploading-architectures, docs/README)
to instruct contributors to use npm from the monorepo root instead of pnpm.
- README badge pnpm 9+ → npm 10+
- All install/dev/build/test commands rewritten as npm with --workspace=calmguard
(or --workspace=calmguard-docs for the docs site)
- Clone instructions point at finos/architecture-as-code (the monorepo) instead
of the standalone hackathon repo
- Both root- and calm-guard-relative invocations documented where useful
Refs #2328.
Signed-off-by: Gourav Shah <gjs@opsflow.sh>
Copy file name to clipboardExpand all lines: calm-suite/calm-guard/AGENTS.md
+13-5Lines changed: 13 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Built for the DTCC/FINOS Innovate.DTCC AI Hackathon (Feb 23-27, 2026).
11
11
| Layer | Choice | Notes |
12
12
|-------|--------|-------|
13
13
| Framework | Next.js 14+ (App Router) |`src/app/` routing, API routes for SSE |
14
-
| Package Manager |pnpm | Use `pnpm` for all package operations|
14
+
| Package Manager |npm (workspaces) | CalmGuard is a workspace of the monorepo root. Run `npm` commands from the repo root or use `--workspace=calmguard`. The docs sub-package is `calmguard-docs`.|
15
15
| Language | TypeScript (strict mode) | No `any` types. Use Zod for runtime validation |
16
16
| LLM SDK | Vercel AI SDK (`ai`) |`generateObject` with Zod schemas for all agent outputs |
17
17
| Default LLM | Google Gemini |`@ai-sdk/google`. Multi-provider: also supports Anthropic, OpenAI, Ollama, Grok |
@@ -70,15 +70,17 @@ You could [Access the Presentation ->](https://github.com/finos-labs/dtcch-2026-
70
70
71
71
### Prerequisites
72
72
73
-
-**Node.js 22+** and **pnpm 9+**
73
+
-**Node.js 22+** and **npm 10+**
74
74
- At least one LLM provider API key (Gemini is the default)
75
75
76
76
### Setup
77
77
78
+
CalmGuard is a workspace of the [`finos/architecture-as-code`](https://github.com/finos/architecture-as-code) monorepo. Clone the monorepo and install all workspaces from the root:
Copy file name to clipboardExpand all lines: calm-suite/calm-guard/docs/README.md
+23-3Lines changed: 23 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,24 +2,44 @@
2
2
3
3
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4
4
5
+
It is published as the `calmguard-docs` workspace of the [`finos/architecture-as-code`](https://github.com/finos/architecture-as-code) monorepo.
6
+
5
7
## Installation
6
8
9
+
From the monorepo root:
10
+
7
11
```bash
8
-
pnpm install
12
+
npm ci
9
13
```
10
14
11
15
## Local Development
12
16
17
+
From the monorepo root:
18
+
19
+
```bash
20
+
npm run start --workspace=calmguard-docs
21
+
```
22
+
23
+
Or from `calm-suite/calm-guard/`:
24
+
13
25
```bash
14
-
pnpm start
26
+
npm run docs:dev
15
27
```
16
28
17
29
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18
30
19
31
## Build
20
32
33
+
From the monorepo root:
34
+
35
+
```bash
36
+
npm run build --workspace=calmguard-docs
37
+
```
38
+
39
+
Or from `calm-suite/calm-guard/`:
40
+
21
41
```bash
22
-
pnpm build
42
+
npm run docs:build
23
43
```
24
44
25
45
This command generates static content into the `build` directory and can be served using any static contents hosting service.
Copy file name to clipboardExpand all lines: calm-suite/calm-guard/docs/docs/contributing.md
+16-14Lines changed: 16 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,18 +12,20 @@ CALMGuard is an open-source project built for the DTCC/FINOS Innovate Hackathon
12
12
### Prerequisites
13
13
14
14
- Node.js 22+
15
-
-pnpm 9+
15
+
-npm 10+
16
16
- A Gemini API key (free tier works for development)
17
17
18
18
### Installation
19
19
20
+
CalmGuard lives in the [`finos/architecture-as-code`](https://github.com/finos/architecture-as-code) monorepo as the `calmguard` npm workspace.
Copy file name to clipboardExpand all lines: calm-suite/calm-guard/docs/docs/getting-started.md
+13-7Lines changed: 13 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,28 +12,32 @@ Get CALMGuard running locally in under 5 minutes.
12
12
| Requirement | Minimum Version | Notes |
13
13
|------------|-----------------|-------|
14
14
| Node.js | 22+ | LTS recommended |
15
-
|pnpm|9+ |`npm install -g pnpm`|
15
+
|npm|10+ |Ships with Node 22|
16
16
| Git | Any | For cloning |
17
17
| Google Gemini API key | — | Free tier sufficient for demo |
18
18
19
+
CalmGuard is the `calmguard` workspace inside the [`finos/architecture-as-code`](https://github.com/finos/architecture-as-code) monorepo. All commands run from the monorepo root.
0 commit comments