Skip to content

docs(vscode): describe CALM Canvas on the VS Code extension page (#3543) - #3597

Open
CG-5228 wants to merge 2 commits into
finos:mainfrom
CG-5228:docs/vscode-extension-calm-canvas
Open

CG-5228 wants to merge 2 commits into
finos:mainfrom
CG-5228:docs/vscode-extension-calm-canvas

Conversation

@CG-5228

@CG-5228 CG-5228 commented Nov 2, 2026

Copy link
Copy Markdown
Contributor

Overview

Resolves #3543

Updates docs/docs/working-with-calm/vscode-extension.md so the documentation reflects the current CALM Canvas (FINOS.calm-vscode-plugin) extension instead of the retired CalmPreview extension:

  • Replaces references to CalmPreview, CalmPreview.preview, CalmPreview.logLevel, CalmPreview.customCss, CalmPreview.templateDirectory, .calm.yaml activation, the Docify tab, Mermaid/PlantUML live preview, and non-existent CALM CLI subcommands (calm init, calm generate --platform kubernetes) with accurate CALM Canvas documentation.
  • Describes the ReactFlow visual editor workflow using core CALM concepts (Standards, Controls, and Patterns).
  • Documents all commands contributed by calm-plugins/vscode/package.json (calm.openCanvas, calm.connectToHub, calm.disconnectFromHub, calm.refreshFromHub, and calm.importSvg), keybindings (Cmd+Shift+K / Ctrl+Shift+K), and calm.* settings (calm.externalAssetsPath, calm.packs.enabled, calm.packs.excludeNodes, calm.hub.url, calm.hub.autoConnect, and calm.hub.selectedNamespaces).

Checklist

  • Verify all documented commands, keybindings, and configuration settings match calm-plugins/vscode/package.json
  • Verify the documentation uses agreed CALM concepts (Standards, Controls, Patterns)
  • Sign-off the commit with git commit -s

@CG-5228
CG-5228 requested a review from a team as a code owner November 2, 2026 01:16
@github-actions github-actions Bot added the docs Improvements of additions to documentation label Nov 2, 2026
@CG-5228
CG-5228 force-pushed the docs/vscode-extension-calm-canvas branch from 87397ba to 0ff3215 Compare November 2, 2026 23:26
@jimthompson5802

jimthompson5802 commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

@CG-5228 I'm reviewing this PR. An initial observation, screenshots of the new UI is missing. In the prior version of the documentation there were screenshots of VSCode extension windows, which help orient the user. Is there a reason that screenshots of the UI are not included?

I still have to do more complete review. I just wanted to get this first observation out.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements of additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: describe CALM Canvas on the VS Code extension page

2 participants