diff --git a/docs/docs.yml b/docs/docs.yml
index 98f88f64c..e79b663d4 100644
--- a/docs/docs.yml
+++ b/docs/docs.yml
@@ -42,7 +42,7 @@ navigation:
- page: Nextjs
path: docs/get-started/deploying/nextjs.mdx
- page: AWS
- - path: docs/get-started/deploying/aws.mdx
+ path: docs/get-started/deploying/aws.mdx
- section: BAML Snippets
contents:
- section: General BAML Syntax
diff --git a/docs/docs/calling-baml/generate-baml-client.mdx b/docs/docs/calling-baml/generate-baml-client.mdx
index 9efcd9461..9deecddbc 100644
--- a/docs/docs/calling-baml/generate-baml-client.mdx
+++ b/docs/docs/calling-baml/generate-baml-client.mdx
@@ -146,17 +146,63 @@ jobs:
1. VSCode extension
2. the installed baml dependency (e.g., `baml-py`)
-Since the extension auto-updates, it's possible that you see an error like:
+Since the extension auto-updates, it's possible that it stops generating the client due to a version mismatch with the `generator` version. You might see an error like:
```bash
-Generator disabled...
+BAML: Code Generation disabled due to version mismatch... See the fix.
```
-when the version of the extension doesn't match what's in your `generator` clause.
-To fix any version mismatch issues you should update all these things to the same version:
+**To fix any version mismatch issues, update all these things to the same version:**
1. VSCode extension
2. the installed baml dependency (e.g., `baml-py`)
-3. the version in your `generator` clause
+ - python: `pip install --upgrade package_name`
+ - typescript: `npm install @boundaryml/baml@latest`
+3. the `version` in your `generator` clause
-If you want to prevent this error from happening, you can
-1. Disable VSCode
+Only the minor and major versions are checked for compatibility (0.0.x).
+
+You can also tweak the generator settings below for a better experience.
+
+#### VSCode generator settings
+
+If set, will make the extension use the baml-cli you have installed on your system to generate the client. This prevents mismatches between the generated code and the installed BAML package.
+
+If you use unix, you can run `where baml-cli` in your project to figure out what the path is.
+
+If you have multiple BAML projects, ensure that this path is set to baml package installed for that project.
+
+
+
+Possible options: `always`, `never`.
+
+
+If you choose `never`, you will have to run the `baml-cli generate` command manually.
+
+
+
+
+
+
+#### `baml-cli generate` arguments
+
+
+Path to the BAML source directory. This is where the BAML files are located.
+
+
+
+If set, it will disable checking the BAML source version with the installed BAML package version before generating code.
+
\ No newline at end of file
diff --git a/docs/docs/get-started/debugging/vscode-playground.mdx b/docs/docs/get-started/debugging/vscode-playground.mdx
index f7fbd6dec..f2b69edef 100644
--- a/docs/docs/get-started/debugging/vscode-playground.mdx
+++ b/docs/docs/get-started/debugging/vscode-playground.mdx
@@ -30,3 +30,6 @@ We've seen sparse repros of this, but closing the playground and reopening it sh
You can debug the actual network request being made by BAML by opening developer tools:
+
+### BAML Client Generation Disabled
+This means your `generator` clause in your BAML file is out of sync with the version of the BAML extension you have installed. See [Generate](../../calling-baml/generate-baml-client.mdx) for more details.
\ No newline at end of file
diff --git a/typescript/vscode-ext/packages/package.json b/typescript/vscode-ext/packages/package.json
index 2e02035f7..1aece7177 100644
--- a/typescript/vscode-ext/packages/package.json
+++ b/typescript/vscode-ext/packages/package.json
@@ -47,7 +47,7 @@
"description": "Use the locally installed baml CLI instead of the one bundled with the extension. Helps keeps generated code more in sync.",
"scope": "machine-overridable"
},
- "generateCodeOnSave": {
+ "baml.generateCodeOnSave": {
"type": "string",
"default": "always",
"enum": [