feat(docs): merge calm-studio docs into main docs site (#2331)#2413
Merged
markscott-ms merged 7 commits intoMay 10, 2026
Merged
Conversation
- Add calm-suite/calm-studio (orchestration root) and all sub-packages/apps to root npm workspaces: - calm-suite/calm-studio - calm-suite/calm-studio/packages/* (calm-core, extensions, mcp-server, github-action, vscode-extension, web-component, calmscript) - calm-suite/calm-studio/apps/* (studio) - calm-suite/calm-studio/docs-site - Convert all 9 workspace:* references to file: relative paths (apps/studio, packages/github-action, packages/mcp-server, packages/vscode-extension, packages/web-component dependencies) - Remove "packageManager: pnpm@..." from migrated package.json files - Merge pnpm.overrides into root package.json overrides - Align extensions vitest from ^4.1.0 to ^3.2.4 + @vitest/coverage-v8 to ^3.2.4 (pnpm strict isolation hid the version drift; npm requires alignment to single hoisted version) - Fix apps/studio/vite.config.ts to import defineConfig from 'vitest/config' instead of 'vite' (test field was incompatible with vite's UserConfigExport type) - Update apps/studio/src-tauri/tauri.conf.json beforeDevCommand/beforeBuildCommand to use "npm run dev"/"npm run build" instead of "pnpm dev"/"pnpm build" - Delete calm-suite/calm-studio/pnpm-workspace.yaml and pnpm-lock.yaml - Rewrite three CI workflows to use npm: - build-calm-studio.yml: actions/setup-node with cache: npm, npm ci, npm run --workspace=... --if-present for build/lint/typecheck/test across all 8 packages - build-calm-studio-desktop.yml: same setup pattern; tauriScript "npm run tauri --workspace=@calmstudio/studio" - automated-release-calm-studio.yml: npm-based bootstrap before multi-semantic-release - Regenerate root package-lock.json (single source of truth) Independent of finos#2407 (calm-guard half). Lockfile and root package.json overlap with finos#2407 will need rebase on whichever PR merges second. Refs finos#2328 (calm-studio half). Signed-off-by: Gourav Shah <gjs@opsflow.sh>
Sweep calm-studio README, AGENTS.md, package READMEs, and the docs-site for pnpm references and replace them with npm workspace equivalents. - calm-studio/README.md and AGENTS.md: install/build/test/dev commands rewritten as npm with --workspace=@calmstudio/... - calm-studio/packages/calm-core/README.md: install instructions - calm-studio/docs-site/docs/getting-started/quick-start.md: prereqs + commands - calm-studio/docs-site/docs/developer-guide/contributing.md: install + check suite - calm-studio/docs-site/docs/developer-guide/extension-packs.md: pack scaffolding commands - calm-studio/docs-site/docs/adrs/0008-docusaurus-for-documentation.md: update consequences note about workspace integration Refs finos#2328. Signed-off-by: Gourav Shah <gjs@opsflow.sh>
Migrates 17 markdown files from calm-suite/calm-studio/docs-site/docs/ into docs/docs/calm-studio/, preserving git history via git mv. Adds calmStudioSidebar to docs/sidebars.js and a CALM Studio navbar item to docs/docusaurus.config.js. Migrates the calmstudio01.png static asset under a calmstudio/ subdirectory to avoid root img/ collisions. Rewrites 8 absolute /docs/ links and 2 image paths to match new routing under the main site (routeBasePath: '/'). Updates calm-core README to point at the new canonical docs URL https://calm.finos.org/calm-studio/intro. Sidebar ADR IDs use Docusaurus-generated form (numeric prefix stripped by default): e.g. 'calm-studio/adrs/use-svelte-5-over-react' not 'calm-studio/adrs/0001-use-svelte-5-over-react'. TypeDoc API reference is intentionally deferred to a follow-up issue (requires docusaurus-plugin-typedoc not yet present in main config). Resolves finos#2331. Signed-off-by: Gourav Shah <gjs@opsflow.sh>
Removes the calmstudio-docs entry from root package.json workspaces (added by finos#2408) now that its content lives in the main docs site (see previous commit). Regenerates package-lock.json to drop the calmstudio-docs package and its transitive dependencies. Note: calm-suite/calm-studio/pnpm-workspace.yaml was already cleaned up in Phase 2 (d446522). No --filter '!calmstudio-docs' existed in build-calm-studio.yml on the Phase 2 branch (it was rewritten to use npm --workspace flags). Resolves finos#2331 (with previous commit). Signed-off-by: Gourav Shah <gjs@opsflow.sh>
gjs-opsflo
requested review from
a team,
eddie-knight,
jpgough-ms,
markscott-ms,
opsflowanoop and
rocketstack-matt
as code owners
9 tasks
…e-docs-into-main # Conflicts: # .github/workflows/automated-release-calm-studio.yml # .github/workflows/build-calm-studio-desktop.yml # .github/workflows/build-calm-studio.yml # calm-suite/calm-studio/docs-site/package.json # calm-suite/calm-studio/pnpm-lock.yaml # package-lock.json # package.json
The Playwright webServer was still spawning the dev server with pnpm, but the runner has no pnpm after the npm-workspaces migration. Use npm run dev so the e2e CI job can start the server. Signed-off-by: Matthew Bain <66839492+rocketstack-matt@users.noreply.github.com>
Under npm workspaces, @sveltejs/kit (and friends) install at calm-suite/calm-studio/node_modules rather than at apps/studio/node_modules, which is outside Vite's default fs.allow root. Without this, Playwright's dev server boots but every page request fails with 'outside of Vite serving allow list', and all 14 e2e tests fail with timeouts on the first locator. Signed-off-by: Matthew Bain <66839492+rocketstack-matt@users.noreply.github.com>
Member
|
This had been left for a while with conflicts so I've fixed them up - given both @gjs-opsflo and myself have touched it, can @opsflowanoop @eddie-knight @jpgough-ms or @markscott-ms as other codeowners of calm-studio please review |
markscott-ms
approved these changes
May 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Merges the standalone
calm-suite/calm-studio/docs-site/Docusaurus instance into the maindocs/site. Single deployment atcalm.finos.orgafter this lands.git mv— history preserved) todocs/docs/calm-studio/calmStudioSidebar+ navbar item indocs/sidebars.jsanddocs/docusaurus.config.jscalmstudio01.pngmigrated todocs/static/img/calmstudio/(namespaced to avoid root img/ collisions)/docs/links in intro.md, 2 image paths, 1 deferred-API note in mcp-server.md, 1 prose path in contributing.mdcalm-core/README.mdupdated to linkhttps://calm.finos.org/calm-studio/introcalm-suite/calm-studio/docs-site/directory deletedcalmstudio-docsremoved from rootpackage.jsonworkspaces (added by chore(calm-suite): migrate calm-studio to npm workspaces #2408) andpackage-lock.jsonregeneratedNote: Sidebar ADR document IDs use Docusaurus-generated form (numeric prefix stripped by default, e.g.
calm-studio/adrs/use-svelte-5-over-reactnot0001-use-svelte-5-over-react).Dependency on #2408
This PR is branched off
chore/calm-studio-npm-workspaces(the #2408 branch). It removes thecalmstudio-docsworkspace entry that #2408 adds.Recommended merge order: #2408 first, then this PR. If #2408 merges first, this branch will be rebased onto the updated
mainbefore merge — the workspace-removal commit will then be a no-op againstmain's workspaces and only the directory deletion will remain.If #2408 is changed substantially, this PR will need rework.
Deferred (follow-up issues)
docs/api/from docs-site) — requires addingdocusaurus-plugin-typedocto main configworking-with-calm/installation.mdto CALM Studio getting-startedcontributing.mdreferences tofinos/calmstudiorepo governance files (CONTRIBUTING.md, CODE_OF_CONDUCT) — should point atfinos/architecture-as-codeequivalentsTest plan
npm run build --workspace docspasses locally withonBrokenLinks: 'throw'docs/build/calm-studio/intro/index.htmlgeneratedCo-Authored-By:lines/calm-studio/introon a preview deploy (if available)Resolves #2331.