Skip to content

docs(vscode): update CALM Canvas contributor and user guides - #3237

Merged
markscott-ms merged 3 commits into
finos:mainfrom
lui01212:codex/fix-contributor-docs
Oct 12, 2026
Merged

markscott-ms merged 3 commits into
finos:mainfrom
lui01212:codex/fix-contributor-docs

Conversation

@lui01212

@lui01212 lui01212 commented Oct 4, 2026

Copy link
Copy Markdown
Contributor

Description

The extension README and assistant guide still describe the removed Tree View and preview architecture. Update both documents for the current CALM Canvas implementation.

The README explains opening supported model files, canvas editing and saving, validation, SVG export, and the three current settings. AGENTS.md now maps the extension host, ReactFlow/Zustand webview, message contracts, synchronization, and current workspace build/test commands.

Closes #3209. This change is limited to the two extension documentation files and does not overlap the documentation-site work in #2937.

AI assistance was used to prepare this documentation change.

Type of Change

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📚 Documentation update
  • 🎨 Code style/formatting changes
  • ♻️ Refactoring (no functional changes)
  • ⚡ Performance improvements
  • ✅ Test additions or updates
  • 🔧 Chore (maintenance, dependencies, CI, etc.)

Affected Components

  • CLI (cli/)
  • Schema (calm/)
  • CALM AI (calm-ai/)
  • CALM Hub (calm-hub/)
  • CALM Hub UI (calm-hub-ui/)
  • CALM Server (calm-server/)
  • CALM Widgets (calm-widgets/)
  • Documentation (docs/)
  • Shared (shared/)
  • VS Code Extension (calm-plugins/vscode/)
  • Dependencies
  • CI/CD

Commit Message Format ✅

docs(vscode): update CALM Canvas contributor and user guides

Testing

  • I have tested my changes locally — static documentation checks only.
  • I have added/updated unit tests — not applicable to these documentation changes.
  • All existing tests pass — not run.

Verified command IDs, settings, supported suffixes, minimum VS Code version, workspace scripts, source paths, relative links, and the JSON example against the current source and manifest. git diff --check passes. No runtime, build, unit tests, or VS Code UI testing was performed; the isolated Docker environment was unresponsive.

Checklist

  • My commits follow the conventional commit format
  • I have updated documentation if necessary
  • I have added tests for my changes (if applicable) — not applicable
  • My changes follow the project's coding standards

The commit includes a DCO sign-off.

@lui01212
lui01212 requested a review from a team as a code owner October 4, 2026 01:04
@linux-foundation-easycla

linux-foundation-easycla Bot commented Oct 4, 2026 •

Copy link
Copy Markdown

CLA Signed
The committers listed above are authorized under a signed CLA.

  • ✅ login: lui01212 / name: Lui Lui (69264eb)

Signed-off-by: Lui Lui <40736418+lui01212@users.noreply.github.com>
@lui01212
lui01212 force-pushed the codex/fix-contributor-docs branch from 69264eb to 53b3a03 Compare October 5, 2026 01:38
@lui01212

lui01212 commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor Author

Rebased on main to resolve the conflict with 6be8ad4. I kept its new Bundled Schemas section in AGENTS.md as written.

markscott-ms and others added 2 commits October 11, 2026 22:23
Comment thread calm-plugins/vscode/AGENTS.md Resolved

@markscott-ms markscott-ms left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your contribution!

@markscott-ms
markscott-ms merged commit c2e1203 into finos:main Oct 12, 2026
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

VS Code extension README and AGENTS.md describe features that CALM Canvas removed

2 participants