Assemblies: Make Clone available in releases (#6538)

* Assemblies: Make Clone available in releases
Fixes #6537

* Lint

.codespellrc

@@ -1,3 +1,3 @@
 [codespell]
 ignore-words-list: crate,everytime,inout,co-ordinate,ot,nwo,atleast,ue,afterall,ser,fromM,FromM
-skip: **/target,node_modules,build,dist,./out,**/Cargo.lock,./docs/kcl/*.md,.package-lock.json,**/package-lock.json,./openapi/*.json,./packages/codemirror-lang-kcl/test/all.test.ts,./public/kcl-samples,./rust/kcl-lib/tests/kcl_samples,tsconfig.tsbuildinfo,./src/lib/machine-api.d.ts
+skip: **/target,node_modules,build,dist,./out,**/Cargo.lock,./docs/kcl/*.md,./e2e/playwright/lib/console-error-whitelist.ts,.package-lock.json,**/package-lock.json,./openapi/*.json,./packages/codemirror-lang-kcl/test/all.test.ts,./public/kcl-samples,./rust/kcl-lib/tests/kcl_samples,tsconfig.tsbuildinfo,./src/lib/machine-api.d.ts

.eslintrc.json

@@ -19,6 +19,11 @@
     "plugin:jsx-a11y/recommended",
     "plugin:react-hooks/recommended"
   ],
+  "settings": {
+    "react": {
+      "version": "detect"
+    }
+  },
   "rules": {
     "no-array-constructor": "off", // This is wrong; use the @typescript-eslint one instead.
     "@typescript-eslint/no-array-constructor": "error",
@@ -61,6 +66,7 @@
     "jsx-a11y/click-events-have-key-events": "off",
     "jsx-a11y/no-autofocus": "off",
     "jsx-a11y/no-noninteractive-element-interactions": "off",
+    "react/no-unknown-property": "error",
     "no-restricted-globals": [
       "error",
       {

.github/ci-cd-scripts/playwright-electron.sh

@@ -26,8 +26,8 @@ max_retries=1
 # Retry failed tests, doing our own retries because using inbuilt Playwright retries causes connection issues
 while [[ $retry -le $max_retries ]]; do
     if [[ -f "test-results/.last-run.json" ]]; then
-        failed_tests=$(jq '.failedTests | length' test-results/.last-run.json)
+        status=$(jq -r '.status' test-results/.last-run.json)
-        if [[ $failed_tests -gt 0 ]]; then
+        if [[ "$status" == "failed" ]]; then
             echo "retried=true" >>$GITHUB_OUTPUT
             echo "run playwright with last failed tests and retry $retry"
             if [[ "$3" == *ubuntu* ]]; then
@@ -56,10 +56,11 @@ done
 echo "retried=false" >>$GITHUB_OUTPUT
 
 if [[ -f "test-results/.last-run.json" ]]; then
-    failed_tests=$(jq '.failedTests | length' test-results/.last-run.json)
+    status=$(jq -r '.status' test-results/.last-run.json)
-    if [[ $failed_tests -gt 0 ]]; then
+    if [[ "$status" == "failed" ]]; then
-        # If it still fails after 3 retries, then fail the job
+        # If it still fails after retries, then fail the job
         exit 1
     fi
 fi
+
 exit 0

.github/workflows/cargo-bench.yml

@@ -26,12 +26,8 @@ name: cargo bench
 jobs:
   cargo-bench:
     name: cargo bench
-    runs-on:
+    runs-on: ubuntu-latest
-      - runs-on=${{ github.run_id }}
-      - runner=32cpu-linux-x64
-      - extras=s3-cache
     steps:
-      - uses: runs-on/action@v1
       - uses: actions/checkout@v4
       - name: Use correct Rust toolchain
         shell: bash
@@ -50,13 +46,12 @@ jobs:
       - name: Build the benchmark target(s)
         run: |
           cd rust
-          cargo codspeed build --measurement-mode walltime
+          cargo codspeed build
       - name: Run the benchmarks
         uses: CodSpeedHQ/action@v3
         with:
           working-directory: rust
           run: cargo codspeed run
           token: ${{ secrets.CODSPEED_TOKEN }}
-          mode: walltime
         env:
           KITTYCAD_API_TOKEN: ${{ secrets.KITTYCAD_API_TOKEN }}

.github/workflows/cargo-test.yml

@@ -13,10 +13,14 @@ concurrency:
   cancel-in-progress: true
 name: cargo test
 jobs:
-  cargotest:
+  build-test-artifacts:
-    name: cargo test
+    name: Build test artifacts
-    runs-on: ubuntu-latest-8-cores
+    runs-on:
+      - runs-on=${{ github.run_id }}
+      - runner=8cpu-linux-x64
+      - extras=s3-cache
     steps:
+      - uses: runs-on/action@v1
       - uses: actions/create-github-app-token@v1
         id: app-token
         with:
@@ -39,7 +43,6 @@ jobs:
         env:
           GH_ACTIONS_AXIOM_TOKEN: ${{ secrets.GH_ACTIONS_AXIOM_TOKEN }}
           OS_NAME: ${{ env.OS_NAME }}
-      - uses: taiki-e/install-action@cargo-llvm-cov
       - uses: taiki-e/install-action@nextest
       - name: Install just
         uses: taiki-e/install-action@just
@@ -81,11 +84,10 @@ jobs:
         run: |
           set -euo pipefail
           cd rust
-          cargo nextest run --workspace --retries=2 --no-fail-fast --profile ci simulation_tests::kcl_samples 2>&1 | tee /tmp/github-actions.log
+          cargo nextest run --workspace --features artifact-graph --retries=2 --no-fail-fast --profile ci simulation_tests::kcl_samples 2>&1 | tee /tmp/github-actions.log
         env:
           KITTYCAD_API_TOKEN: ${{secrets.KITTYCAD_API_TOKEN}}
           RUST_BACKTRACE: full
-          RUST_MIN_STACK: 10485760000
       - name: Commit differences
         if: steps.path-changes.outputs.outside-kcl-samples == 'false' && steps.cargo-test-kcl-samples.outcome == 'failure'
         shell: bash
@@ -118,23 +120,67 @@ jobs:
           # Configure nextest when it's run by insta (via just).
           NEXTEST_PROFILE: ci
           RUST_BACKTRACE: full
-          RUST_MIN_STACK: 10485760000
+      - name: Build and archive tests
-      - name: cargo test
+        run: |
-        if: steps.path-changes.outputs.outside-kcl-samples == 'true'
+          cd rust
+          cargo nextest archive --workspace --features artifact-graph --archive-file nextest-archive.tar.zst
+      - name: Upload archive to workflow
+        uses: actions/upload-artifact@v4
+        with:
+          name: nextest-archive
+          path: rust/nextest-archive.tar.zst
+
+  run-test-artifacts:
+    name: cargo test (shard ${{ matrix.partitionIndex}})
+    runs-on:
+      - runs-on=${{ github.run_id }}
+      - runner=32cpu-linux-x64
+      - extras=s3-cache
+    needs: build-test-artifacts
+    strategy:
+      fail-fast: false
+      matrix:
+        partitionIndex: [1, 2, 3, 4, 5, 6]
+        partitionTotal: [6]
+    steps:
+      - uses: runs-on/action@v1
+      - uses: actions/create-github-app-token@v1
+        id: app-token
+        with:
+          app-id: ${{ secrets.MODELING_APP_GH_APP_ID }}
+          private-key: ${{ secrets.MODELING_APP_GH_APP_PRIVATE_KEY }}
+          owner: ${{ github.repository_owner }}
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ steps.app-token.outputs.token }}
+      - name: Use correct Rust toolchain
+        shell: bash
+        run: |
+          [ -e rust-toolchain.toml ] || cp rust/rust-toolchain.toml ./
+      - name: Install rust
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          cache: false # Configured below.
+      - name: Start Vector
+        run: .github/ci-cd-scripts/start-vector-ubuntu.sh
+        env:
+          GH_ACTIONS_AXIOM_TOKEN: ${{ secrets.GH_ACTIONS_AXIOM_TOKEN }}
+          OS_NAME: ${{ env.OS_NAME }}
+      - uses: taiki-e/install-action@nextest
+      - name: Download archive
+        uses: actions/download-artifact@v4
+        with:
+          name: nextest-archive
+      - name: Run tests
         shell: bash
         run: |-
+          cp nextest-archive.tar.zst rust/nextest-archive.tar.zst
+          ls -lah
           cd rust
-          cargo llvm-cov nextest --workspace --lcov --output-path lcov.info --retries=2 --no-fail-fast -P ci 2>&1 | tee /tmp/github-actions.log
+          cargo nextest run\
+           --retries=2 --no-fail-fast -P ci --archive-file nextest-archive.tar.zst \
+           --partition count:${{ matrix.partitionIndex}}/${{ matrix.partitionTotal }} \
+           2>&1 | tee /tmp/github-actions.log
         env:
           KITTYCAD_API_TOKEN: ${{secrets.KITTYCAD_API_TOKEN}}
-          RUST_MIN_STACK: 10485760000
-      - name: Upload to codecov.io
-        if: steps.path-changes.outputs.outside-kcl-samples == 'true'
-        uses: codecov/codecov-action@v5
-        with:
-          token: ${{secrets.CODECOV_TOKEN}}
-          fail_ci_if_error: true
-          flags: rust
-          verbose: true
-          files: lcov.info
 

.github/workflows/e2e-tests.yml

@@ -3,7 +3,6 @@ on:
   push:
     branches:
       - main
-      - all-e2e # this bypasses `fixme()` using `orRunWhenFullSuiteEnabled()`
   pull_request:
   schedule:
     - cron: 0 * * * *  # hourly
@@ -226,8 +225,8 @@ jobs:
         with:
           shell: bash
           command: npm run test:snapshots
-          timeout_minutes: 30
+          timeout_minutes: 5
-          max_attempts: 3
+          max_attempts: 5
         env:
           token: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}
           snapshottoken: ${{ secrets.KITTYCAD_API_TOKEN }}
@@ -278,28 +277,42 @@ jobs:
     timeout-minutes: 60
     env:
       OS_NAME: ${{ contains(matrix.os, 'ubuntu') && 'ubuntu' || (contains(matrix.os, 'windows') && 'windows' || 'macos') }}
-    name: playwright:electron:${{ contains(matrix.os, 'ubuntu') && 'ubuntu' || (contains(matrix.os, 'windows') && 'windows' || 'macos') }}:${{ matrix.shardIndex }}:${{ matrix.shardTotal }}
+    name: playwright:electron:${{ contains(matrix.os, 'ubuntu') && 'ubuntu' || (contains(matrix.os, 'windows') && 'windows' || 'macos') }} (shard ${{ matrix.shardIndex }})
     strategy:
       fail-fast: false
       matrix:
         # TODO: enable namespace-profile-windows-latest once available
-        os:
+        include:
-          - "runs-on=${{ github.run_id }}/family=i7ie.2xlarge/image=ubuntu22-full-x64"
+          - os: "runs-on=${{ github.run_id }}/family=i7ie.2xlarge/image=ubuntu22-full-x64"
-          - namespace-profile-macos-8-cores
+            shardIndex: 1
-          - windows-latest-8-cores
+            shardTotal: 8
-        shardIndex: [1, 2, 3, 4]
+          - os: "runs-on=${{ github.run_id }}/family=i7ie.2xlarge/image=ubuntu22-full-x64"
-        shardTotal: [4]
+            shardIndex: 2
-        # Disable macos and windows tests on hourly e2e tests since we only care
+            shardTotal: 8
-        # about server side changes.
+          - os: "runs-on=${{ github.run_id }}/family=i7ie.2xlarge/image=ubuntu22-full-x64"
-        # Technique from https://github.com/joaomcteixeira/python-project-skeleton/pull/31/files
+            shardIndex: 3
-        isScheduled:
+            shardTotal: 8
-          - ${{ github.event_name == 'schedule' }}
+          - os: "runs-on=${{ github.run_id }}/family=i7ie.2xlarge/image=ubuntu22-full-x64"
-        exclude:
+            shardIndex: 4
+            shardTotal: 8
+          - os: "runs-on=${{ github.run_id }}/family=i7ie.2xlarge/image=ubuntu22-full-x64"
+            shardIndex: 5
+            shardTotal: 8
+          - os: "runs-on=${{ github.run_id }}/family=i7ie.2xlarge/image=ubuntu22-full-x64"
+            shardIndex: 6
+            shardTotal: 8
+          - os: "runs-on=${{ github.run_id }}/family=i7ie.2xlarge/image=ubuntu22-full-x64"
+            shardIndex: 7
+            shardTotal: 8
+          - os: "runs-on=${{ github.run_id }}/family=i7ie.2xlarge/image=ubuntu22-full-x64"
+            shardIndex: 8
+            shardTotal: 8
           - os: namespace-profile-macos-8-cores
-            isScheduled: true
+            shardIndex: 1
+            shardTotal: 1
           - os: windows-latest-8-cores
-            isScheduled: true
+            shardIndex: 1
-        # TODO: add ref here for main and latest release tag
+            shardTotal: 1
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4

.github/workflows/update-e2e-branch.yml

@@ -1,45 +0,0 @@
-name: update-e2e-branch
-
-# This is used to sync the `all-e2e` branch with the `main` branch for the
-# logic in the test utility `orRunWhenFullSuiteEnabled()` that allows all e2e
-# tests to run on a particular branch to analyze failures metrics in Axiom.
-
-on:
-  schedule:
-    - cron: '0 * * * *' # runs every hour
-
-permissions:
-  contents: write
-
-jobs:
-  update-branch:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/create-github-app-token@v1
-        id: app-token
-        with:
-          app-id: ${{ secrets.MODELING_APP_GH_APP_ID }}
-          private-key: ${{ secrets.MODELING_APP_GH_APP_PRIVATE_KEY }}
-          owner: ${{ github.repository_owner }}
-
-      - uses: actions/checkout@v4
-        with:
-          token: ${{ steps.app-token.outputs.token }}
-
-      - name: Sync with main
-        run: |
-          # Create the branch
-          git checkout all-e2e || git checkout -b all-e2e
-
-          # Reset to main
-          git fetch origin
-          git reset --hard origin/main
-
-          # Get a new SHA to prevent overwriting the commit status on main
-          git config --local user.email "github-actions[bot]@users.noreply.github.com"
-          git config --local user.name "github-actions[bot]"
-          git commit --allow-empty --message="[all-e2e] $(git log --max-count=1 --pretty=%B)"
-
-          # Overwrite the branch
-          git remote set-url origin https://x-access-token:${{ steps.app-token.outputs.token }}@github.com/${{ github.repository }}.git
-          git push --force origin all-e2e

.helix/languages.toml

@@ -5,6 +5,6 @@ command = "vscode-eslint-language-server"
 [[language]]
 name = "typescript"
 auto-format = true
-formatter = { command = "node_modules/.bin/prettier", args = ["--parser", "typescript"] }
+formatter = { command = "./node_modules/@biomejs/biome/bin/biome", args = ["format", "--write", "--stdin-file-path=foo.ts"] }
-language-servers = [ { name = "eslint", only-features = [ "diagnostics" ] }, "typescript-language-server" ]
+# language-servers = [ { name = "eslint", only-features = [ "diagnostics" ] }, "typescript-language-server" ]
 

.husky/pre-commit

@@ -0,0 +1 @@
+npm run fmt

.husky/pre-push

@@ -1,4 +0,0 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npm run fmt-check

CONTRIBUTING.md

@@ -0,0 +1,432 @@
+# Contributor Guide
+
+## Running a development build
+
+Install a node version manager such as [fnm](https://github.com/Schniz/fnm?tab=readme-ov-#installation).
+
+On Windows, it's also recommended to [upgrade your PowerShell version](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.5#winget), we're using 7.
+
+Then in the repo run the following to install and use the node version specified in `.nvmrc`. You might need to specify your processor architecture with `--arch arm64` or `--arch x64` if it's not autodetected.
+
+```
+fnm install --corepack-enabled
+fnm use
+```
+
+Install the NPM dependencies with:
+
+```
+npm install
+```
+
+This project uses a lot of Rust compiled to [WASM](https://webassembly.org/) within it. We have package scripts to run rustup, see `package.json` for reference:
+
+```
+# macOS/Linux
+npm run install:rust
+npm run install:wasm-pack:sh
+
+# Windows
+npm run install:rust:windows
+npm run install:wasm-pack:cargo
+```
+
+Then to build the WASM layer, run:
+
+```
+# macOS/Linux
+npm run build:wasm
+
+# Windows
+npm run build:wasm:windows
+```
+
+Or if you have the `gh` cli installed and want to download the latest main wasm bundle. Note that on Windows, you need to associate .ps1 files with PowerShell, which can be done via the right click menu, selecting `C:\Program Files\PowerShell\7\pwsh.exe`, and you can install tools like `gh` via `npm run install:tools:windows`.
+
+```
+# macOS/Linux
+npm run fetch:wasm
+
+# Windows
+npm run fetch:wasm:windows
+```
+
+That will build the WASM binary and put in the `public` dir (though gitignored).
+
+Finally, to run the web app only, run:
+
+```
+npm start
+```
+
+If you're not a Zoo employee you won't be able to access the dev environment, you should copy everything from `.env.production` to `.env.development.local` to make it point to production instead, then when you navigate to `localhost:3000` the easiest way to sign in is to paste `localStorage.setItem('TOKEN_PERSIST_KEY', "your-token-from-https://zoo.dev/account/api-tokens")` replacing the with a real token from https://zoo.dev/account/api-tokens of course, then navigate to `localhost:3000` again. Note that navigating to `localhost:3000/signin` removes your token so you will need to set the token again.
+
+### Development environment variables
+
+The Copilot LSP plugin in the editor requires a Zoo API token to run. In production, we authenticate this with a token via cookie in the browser and device auth token in the desktop environment, but this token is inaccessible in the dev browser version because the cookie is considered "cross-site" (from `localhost` to `dev.zoo.dev`). There is an optional environment variable called `VITE_KC_DEV_TOKEN` that you can populate with a dev token in a `.env.development.local` file to not check it into Git, which will use that token instead of other methods for the LSP service.
+
+### Developing in Chrome
+
+Chrome is in the process of rolling out a new default which
+[blocks Third-Party Cookies](https://developer.chrome.com/en/docs/privacy-sandbox/third-party-cookie-phase-out/).
+If you're having trouble logging into the `modeling-app`, you may need to
+enable third-party cookies. You can enable third-party cookies by clicking on
+the eye with a slash through it in the URL bar, and clicking on "Enable
+Third-Party Cookies".
+
+## Desktop
+
+To spin up the desktop app, `npm install` and `npm run build:wasm` need to have been done before hand then:
+
+```
+npm run tron:start
+```
+
+This will start the application and hot-reload on changes.
+
+Devtools can be opened with the usual Command-Option-I (macOS) or Ctrl-Shift-I (Linux and Windows).
+
+To package the app for your platform with electron-builder, run `npm run tronb:package:dev` (or `npm run tronb:package:prod` to point to the .env.production variables).
+
+## Checking out commits / Bisecting
+
+Which commands from setup are one off vs. need to be run every time?
+
+The following will need to be run when checking out a new commit and guarantees the build is not stale:
+
+```bash
+npm install
+npm run build:wasm
+npm start # or npm run build:local && npm run serve for slower but more production-like build
+```
+
+## Before submitting a PR
+
+Before you submit a contribution PR to this repo, please ensure that:
+
+- There is a corresponding issue for the changes you want to make, so that discussion of approach can be had before work begins.
+- You have separated out refactoring commits from feature commits as much as possible
+- You have run all of the following commands locally:
+  - `npm run fmt`
+  - `npm run tsc`
+  - `npm run test`
+  - Here they are all together: `npm run fmt && npm run tsc && npm run test`
+
+## Release a new version
+
+#### 1. Create a 'Cut release $VERSION' issue
+
+It will be used to document changelog discussions and release testing.
+
+https://github.com/KittyCAD/modeling-app/issues/new
+
+#### 2. Push a new tag
+
+Create a new tag and push it to the repo. The `semantic-release.sh` script will automatically bump the minor part, which we use the most. For instance going from `v0.27.0` to `v0.28.0`.
+
+```
+VERSION=$(./scripts/semantic-release.sh)
+git tag $VERSION
+git push origin --tags
+```
+
+This will trigger the `build-apps` workflow, set the version, build & sign the apps, and generate release files as well as updater-test artifacts.
+
+The workflow should be listed right away [in this list](https://github.com/KittyCAD/modeling-app/actions/workflows/build-apps.yml?query=event%3Apush)).
+
+#### 3. Manually test artifacts
+
+##### Release builds
+
+The release builds can be found under the `out-{arch}-{platform}` zip files, at the very bottom of the `build-apps` summary page for the workflow (triggered by the tag in 2.).
+
+Manually test against this [list](https://github.com/KittyCAD/modeling-app/issues/3588) across Windows, MacOS, Linux and posting results as comments in the issue.
+
+##### Updater-test builds
+
+The other `build-apps` output in the release `build-apps` workflow (triggered by 2.) is `updater-test-{arch}-{platform}`. It's a semi-automated process: for macOS, Windows, and Linux, download the corresponding updater-test artifact file, install the app, run it, expect an updater prompt to a dummy v0.255.255, install it and check that the app comes back at that version.
+
+The only difference with these builds is that they point to a different update location on the release bucket, with this dummy v0.255.255 always available. This helps ensuring that the version we release will be able to update to the next one available.
+
+If the prompt doesn't show up, start the app in command line to grab the electron-updater logs. This is likely an issue with the current build that needs addressing (or the updater-test location in the storage bucket).
+
+```
+# Windows (PowerShell)
+& 'C:\Program Files\Zoo Design Studio\Zoo Design Studio.exe'
+
+# macOS
+/Applications/Zoo\ Modeling\ App.app/Contents/MacOS/Zoo\ Modeling\ App
+
+# Linux
+./Zoo Design Studio-{version}-{arch}-linux.AppImage
+```
+
+#### 4. Publish the release
+
+Head over to https://github.com/KittyCAD/modeling-app/releases/new, pick the newly created tag and type it in the _Release title_ field as well.
+
+Hit _Generate release notes_ as a starting point to discuss the changelog in the issue. Once done, make sure _Set as the latest release_ is checked, and hit _Publish release_.
+
+A new `publish-apps-release` will kick in and you should be able to find it [here](https://github.com/KittyCAD/modeling-app/actions?query=event%3Arelease). On success, the files will be uploaded to the public bucket as well as to the GitHub release, and the announcement on Discord will be sent.
+
+#### 5. Close the issue
+
+If everything is well and the release is out to the public, the issue tracking the release shall be closed.
+
+## Fuzzing the parser
+
+Make sure you install cargo fuzz:
+
+```bash
+$ cargo install cargo-fuzz
+```
+
+```bash
+$ cd rust/kcl-lib
+
+# list the fuzz targets
+$ cargo fuzz list
+
+# run the parser fuzzer
+$ cargo +nightly fuzz run parser
+```
+
+For more information on fuzzing you can check out
+[this guide](https://rust-fuzz.github.io/book/cargo-fuzz.html).
+
+## Tests
+
+### Playwright tests
+
+You will need a `./e2e/playwright/playwright-secrets.env` file:
+
+```bash
+$ touch ./e2e/playwright/playwright-secrets.env
+$ cat ./e2e/playwright/playwright-secrets.env
+token=<dev.zoo.dev/account/api-tokens>
+snapshottoken=<zoo.dev/account/api-tokens>
+```
+or use `export` to set the environment variables `token` and `snapshottoken`.
+
+#### Snapshot tests (Google Chrome on Ubuntu only)
+
+Only Ubunu and Google Chrome is supported for the set of tests evaluating screenshot snapshots.
+If you don't run Ubuntu locally or in a VM, you may use a GitHub Codespace.
+```
+npm run playwright -- install chrome
+npm run test:snapshots
+```
+You may use `-- --update-snapshots` as needed.
+
+#### Electron flow tests (Chromium on Ubuntu, macOS, Windows)
+
+```
+npm run playwright -- install chromium
+npm run test:playwright:electron:local
+```
+You may use `-- -g "my test"` to match specific test titles, or `-- path/to/file.spec.ts` for a test file.
+
+#### Debugger
+
+However, if you want a debugger I recommend using VSCode and the `playwright` extension, as the above command is a cruder debugger that steps into every function call which is annoying.
+With the extension you can set a breakpoint after `waitForDefaultPlanesVisibilityChange` in order to skip app loading, then the vscode debugger's "step over" is much better for being able to stay at the right level of abstraction as you debug the code.
+
+If you want to limit to a single browser use `--project="webkit"` or `firefox`, `Google Chrome`
+Or comment out browsers in `playwright.config.ts`.
+
+note chromium has encoder compat issues which is why were testing against the branded 'Google Chrome'
+
+You may consider using the VSCode extension, it's useful for running individual threads, but some some reason the "record a test" is locked to chromium with we can't use. A work around is to us the CI `npm run playwright codegen -b wk --load-storage ./store localhost:3000`
+
+<details>
+<summary>
+
+Where `./store` should look like this
+
+</summary>
+
+```JSON
+{
+  "cookies": [],
+  "origins": [
+    {
+      "origin": "http://localhost:3000",
+      "localStorage": [
+        {
+          "name": "store",
+          "value": "{\"state\":{\"openPanes\":[\"code\"]},\"version\":0}"
+        },
+        {
+          "name": "persistCode",
+          "value": ""
+        },
+        {
+          "name": "TOKEN_PERSIST_KEY",
+          "value": "your-token"
+        }
+      ]
+    }
+  ]
+}
+```
+
+</details>
+
+However because much of our tests involve clicking in the stream at specific locations, it's code-gen looks `await page.locator('video').click();` when really we need to use a pixel coord, so I think it's of limited use.
+
+### Unit and component tests
+
+If you already haven't, run the following:
+
+```
+npm
+npm run build:wasm
+npm start
+```
+
+and finally:
+
+```
+npm run test:unit
+```
+
+For individual testing:
+
+```
+npm run test abstractSyntaxTree -t "unexpected closed curly brace" --silent=false
+```
+
+Which will run our suite of [Vitest unit](https://vitest.dev/) and [React Testing Library E2E](https://testing-library.com/docs/react-testing-library/intro) tests, in interactive mode by default.
+
+### Rust tests
+
+**Dependencies**
+
+- `KITTYCAD_API_TOKEN`
+- `cargo-nextest`
+- `just`
+
+#### Setting KITTYCAD_API_TOKEN
+
+Use the production zoo.dev token, set this environment variable before running the tests
+
+#### Installing cargonextest
+
+```
+cd rust
+cargo search cargo-nextest
+cargo install cargo-nextest
+```
+
+#### just
+
+install [`just`](https://github.com/casey/just?tab=readme-ov-file#pre-built-binaries)
+
+#### Running the tests
+
+```bash
+# With just
+# Make sure KITTYCAD_API_TOKEN=<prod zoo.dev token> is set
+# Make sure you installed cargo-nextest
+# Make sure you installed just
+cd rust
+just test
+```
+
+```bash
+# Without just
+# Make sure KITTYCAD_API_TOKEN=<prod zoo.dev token> is set
+# Make sure you installed cargo-nextest
+cd rust
+export RUST_BRACKTRACE="full" && cargo nextest run --workspace --test-threads=1
+```
+
+Where `XXX` is an API token from the production engine (NOT the dev environment).
+
+We recommend using [nextest](https://nexte.st/) to run the Rust tests (its faster and is used in CI). Once installed, run the tests using
+
+```
+cd rust
+KITTYCAD_API_TOKEN=XXX cargo run nextest
+```
+
+### Mapping CI CD jobs to local commands
+
+When you see the CI CD fail on jobs you may wonder three things
+
+- Do I have a bug in my code?
+- Is the test flaky?
+- Is there a bug in `main`?
+
+To answer these questions the following commands will give you confidence to locate the issue.
+
+#### Static Analysis
+
+Part of the CI CD pipeline performs static analysis on the code. Use the following commands to mimic the CI CD jobs.
+
+The following set of commands should get us closer to one and done commands to instantly retest issues.
+
+```
+npm run test-setup
+```
+
+> Gotcha, are packages up to date and is the wasm built?
+
+```
+npm run tsc
+npm run fmt:check
+npm run lint
+npm run test:unit:local
+```
+
+> Gotcha: Our unit tests have integration tests in them. You need to run a localhost server to run the unit tests.
+
+#### E2E Tests
+
+**Playwright Electron**
+
+These E2E tests run in electron. There are tests that are skipped if they are ran in a windows, linux, or macos environment. We can use playwright tags to implement test skipping.
+
+```
+npm run test:playwright:electron:local
+npm run test:playwright:electron:windows:local
+npm run test:playwright:electron:macos:local
+npm run test:playwright:electron:ubuntu:local
+```
+
+> Why does it say local? The CI CD commands that run in the pipeline cannot be ran locally. A single command will not properly setup the testing environment locally.
+
+#### Some notes on CI
+
+The tests are broken into snapshot tests and non-snapshot tests, and they run in that order, they automatically commit new snap shots, so if you see an image commit check it was an intended change. If we have non-determinism in the snapshots such that they are always committing new images, hopefully this annoyance makes us fix them asap, if you notice this happening let Kurt know. But for the odd occasion `git reset --hard HEAD~ && git push -f` is your friend.
+
+How to interpret failing playwright tests?
+If your tests fail, click through to the action and see that the tests failed on a line that includes `await page.getByTestId('loading').waitFor({ state: 'detached' })`, this means the test fail because the stream never started. It's you choice if you want to re-run the test, or ignore the failure.
+
+We run on ubuntu and macos, because safari doesn't work on linux because of the dreaded "no RTCPeerConnection variable" error. But linux runs first and then macos for the same reason that we limit the number of parallel tests to 1 because we limit stream connections per user, so tests would start failing we if let them run together.
+
+If something fails on CI you can download the artifact, unzip it and then open `playwright-report/data/<UUID>.zip` with https://trace.playwright.dev/ to see what happened.
+
+#### Getting started writing a playwright test in our app
+
+Besides following the instructions above and using the playwright docs, our app is weird because of the whole stream thing, which means our testing is weird. Because we've just figured out this stuff and therefore docs might go stale quick here's a 15min vid/tutorial
+
+https://github.com/KittyCAD/modeling-app/assets/29681384/6f5e8e85-1003-4fd9-be7f-f36ce833942d
+
+<details>
+
+<summary>
+PS: for the debug panel, the following JSON is useful for snapping the camera
+</summary>
+
+```JSON
+{"type":"modeling_cmd_req","cmd_id":"054e5472-e5e9-4071-92d7-1ce3bac61956","cmd":{"type":"default_camera_look_at","center":{"x":15,"y":0,"z":0},"up":{"x":0,"y":0,"z":1},"vantage":{"x":30,"y":30,"z":30}}}
+```
+
+</details>
+
+### Logging
+
+To display logging (to the terminal or console) set `ZOO_LOG=1`. This will log some warnings and simple performance metrics. To view these in test runs, use `-- --nocapture`.
+
+To enable memory metrics, build with `--features dhat-heap`.

Makefile

@@ -15,8 +15,8 @@ ifdef WINDOWS
 CARGO ?= $(USERPROFILE)/.cargo/bin/cargo.exe
 WASM_PACK ?= $(USERPROFILE)/.cargo/bin/wasm-pack.exe
 else
-CARGO ?= ~/.cargo/bin/cargo
+CARGO ?= $(shell which cargo || echo ~/.cargo/bin/cargo)
-WASM_PACK ?= ~/.cargo/bin/wasm-pack
+WASM_PACK ?= $(shell which wasm-pack || echo ~/.cargo/bin/wasm-pack)
 endif
 
 .PHONY: install

README.md

@@ -1,8 +1,8 @@
 ![Zoo Design Studio](/public/zma-logomark-outlined.png)
 
-## Zoo Design Studio
+# Zoo Design Studio
 
-download at [zoo.dev/modeling-app/download](https://zoo.dev/modeling-app/download)
+[zoo.dev/modeling-app](https://zoo.dev/modeling-app)
 
 A CAD application from the future, brought to you by the [Zoo team](https://zoo.dev).
 
@@ -23,7 +23,7 @@ Design Studio is a _hybrid_ user interface for CAD modeling. You can point-and-c
 
 The 3D view in Design Studio is just a video stream from our hosted geometry engine. The app sends new modeling commands to the engine via WebSockets, which returns back video frames of the view within the engine.
 
-## Tools
+## Technology
 
 - UI
   - [React](https://react.dev/)
@@ -38,445 +38,16 @@ The 3D view in Design Studio is just a video stream from our hosted geometry eng
 - Modeling
   - [KittyCAD TypeScript client](https://github.com/KittyCAD/kittycad.ts)
 
-[Original demo video](https://drive.google.com/file/d/183_wjqGdzZ8EEZXSqZ3eDcJocYPCyOdC/view?pli=1)
+## Get Started
 
-[Original demo slides](https://github.com/user-attachments/files/19010536/demo.pdf)
+We recommend downloading the latest application binary from our [releases](https://github.com/KittyCAD/modeling-app/releases) page. If you don't see your platform or architecture supported there, please file an issue.
 
-## Get started
+If you'd like to try out upcoming changes sooner, you can also download those from our [nightly releases](https://zoo.dev/modeling-app/download/nightly) page.
 
-We recommend downloading the latest application binary from [our Releases page](https://github.com/KittyCAD/modeling-app/releases). If you don't see your platform or architecture supported there, please file an issue.
+## Developing
 
-## Running a development build
+Finally, if you'd like to run a development build or contribute to the project, please visit our [contributor guide](CONTRIBUTING.md) to get started.
-
-Install a node version manager such as [fnm](https://github.com/Schniz/fnm?tab=readme-ov-#installation).
-
-On Windows, it's also recommended to [upgrade your PowerShell version](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.5#winget), we're using 7.
-
-Then in the repo run the following to install and use the node version specified in `.nvmrc`. You might need to specify your processor architecture with `--arch arm64` or `--arch x64` if it's not autodetected.
-
-```
-fnm install --corepack-enabled
-fnm use
-```
-
-Install the NPM dependencies with:
-
-```
-npm install
-```
-
-This project uses a lot of Rust compiled to [WASM](https://webassembly.org/) within it. We have package scripts to run rustup, see `package.json` for reference:
-
-```
-# macOS/Linux
-npm run install:rust
-npm run install:wasm-pack:sh
-
-# Windows
-npm run install:rust:windows
-npm run install:wasm-pack:cargo
-```
-
-Then to build the WASM layer, run:
-
-```
-# macOS/Linux
-npm run build:wasm
-
-# Windows
-npm run build:wasm:windows
-```
-
-Or if you have the `gh` cli installed and want to download the latest main wasm bundle. Note that on Windows, you need to associate .ps1 files with PowerShell, which can be done via the right click menu, selecting `C:\Program Files\PowerShell\7\pwsh.exe`, and you can install tools like `gh` via `npm run install:tools:windows`.
-
-```
-# macOS/Linux
-npm run fetch:wasm
-
-# Windows
-npm run fetch:wasm:windows
-```
-
-That will build the WASM binary and put in the `public` dir (though gitignored).
-
-Finally, to run the web app only, run:
-
-```
-npm start
-```
-
-If you're not a Zoo employee you won't be able to access the dev environment, you should copy everything from `.env.production` to `.env.development.local` to make it point to production instead, then when you navigate to `localhost:3000` the easiest way to sign in is to paste `localStorage.setItem('TOKEN_PERSIST_KEY', "your-token-from-https://zoo.dev/account/api-tokens")` replacing the with a real token from https://zoo.dev/account/api-tokens of course, then navigate to `localhost:3000` again. Note that navigating to `localhost:3000/signin` removes your token so you will need to set the token again.
-
-### Development environment variables
-
-The Copilot LSP plugin in the editor requires a Zoo API token to run. In production, we authenticate this with a token via cookie in the browser and device auth token in the desktop environment, but this token is inaccessible in the dev browser version because the cookie is considered "cross-site" (from `localhost` to `dev.zoo.dev`). There is an optional environment variable called `VITE_KC_DEV_TOKEN` that you can populate with a dev token in a `.env.development.local` file to not check it into Git, which will use that token instead of other methods for the LSP service.
-
-### Developing in Chrome
-
-Chrome is in the process of rolling out a new default which
-[blocks Third-Party Cookies](https://developer.chrome.com/en/docs/privacy-sandbox/third-party-cookie-phase-out/).
-If you're having trouble logging into the `modeling-app`, you may need to
-enable third-party cookies. You can enable third-party cookies by clicking on
-the eye with a slash through it in the URL bar, and clicking on "Enable
-Third-Party Cookies".
-
-## Desktop
-
-To spin up the desktop app, `npm install` and `npm run build:wasm` need to have been done before hand then:
-
-```
-npm run tron:start
-```
-
-This will start the application and hot-reload on changes.
-
-Devtools can be opened with the usual Command-Option-I (macOS) or Ctrl-Shift-I (Linux and Windows).
-
-To package the app for your platform with electron-builder, run `npm run tronb:package:dev` (or `npm run tronb:package:prod` to point to the .env.production variables).
-
-## Checking out commits / Bisecting
-
-Which commands from setup are one off vs. need to be run every time?
-
-The following will need to be run when checking out a new commit and guarantees the build is not stale:
-
-```bash
-npm install
-npm run build:wasm
-npm start # or npm run build:local && npm run serve for slower but more production-like build
-```
-
-## Before submitting a PR
-
-Before you submit a contribution PR to this repo, please ensure that:
-
-- There is a corresponding issue for the changes you want to make, so that discussion of approach can be had before work begins.
-- You have separated out refactoring commits from feature commits as much as possible
-- You have run all of the following commands locally:
-  - `npm run fmt`
-  - `npm run tsc`
-  - `npm run test`
-  - Here they are all together: `npm run fmt && npm run tsc && npm run test`
-
-## Release a new version
-
-#### 1. Create a 'Cut release $VERSION' issue
-
-It will be used to document changelog discussions and release testing.
-
-https://github.com/KittyCAD/modeling-app/issues/new
-
-#### 2. Push a new tag
-
-Create a new tag and push it to the repo. The `semantic-release.sh` script will automatically bump the minor part, which we use the most. For instance going from `v0.27.0` to `v0.28.0`.
-
-```
-VERSION=$(./scripts/semantic-release.sh)
-git tag $VERSION
-git push origin --tags
-```
-
-This will trigger the `build-apps` workflow, set the version, build & sign the apps, and generate release files as well as updater-test artifacts.
-
-The workflow should be listed right away [in this list](https://github.com/KittyCAD/modeling-app/actions/workflows/build-apps.yml?query=event%3Apush)).
-
-#### 3. Manually test artifacts
-
-##### Release builds
-
-The release builds can be found under the `out-{arch}-{platform}` zip files, at the very bottom of the `build-apps` summary page for the workflow (triggered by the tag in 2.).
-
-Manually test against this [list](https://github.com/KittyCAD/modeling-app/issues/3588) across Windows, MacOS, Linux and posting results as comments in the issue.
-
-##### Updater-test builds
-
-The other `build-apps` output in the release `build-apps` workflow (triggered by 2.) is `updater-test-{arch}-{platform}`. It's a semi-automated process: for macOS, Windows, and Linux, download the corresponding updater-test artifact file, install the app, run it, expect an updater prompt to a dummy v0.255.255, install it and check that the app comes back at that version.
-
-The only difference with these builds is that they point to a different update location on the release bucket, with this dummy v0.255.255 always available. This helps ensuring that the version we release will be able to update to the next one available.
-
-If the prompt doesn't show up, start the app in command line to grab the electron-updater logs. This is likely an issue with the current build that needs addressing (or the updater-test location in the storage bucket).
-
-```
-# Windows (PowerShell)
-& 'C:\Program Files\Zoo Design Studio\Zoo Design Studio.exe'
-
-# macOS
-/Applications/Zoo\ Modeling\ App.app/Contents/MacOS/Zoo\ Modeling\ App
-
-# Linux
-./Zoo Design Studio-{version}-{arch}-linux.AppImage
-```
-
-#### 4. Publish the release
-
-Head over to https://github.com/KittyCAD/modeling-app/releases/new, pick the newly created tag and type it in the _Release title_ field as well.
-
-Hit _Generate release notes_ as a starting point to discuss the changelog in the issue. Once done, make sure _Set as the latest release_ is checked, and hit _Publish release_.
-
-A new `publish-apps-release` will kick in and you should be able to find it [here](https://github.com/KittyCAD/modeling-app/actions?query=event%3Arelease). On success, the files will be uploaded to the public bucket as well as to the GitHub release, and the announcement on Discord will be sent.
-
-#### 5. Close the issue
-
-If everything is well and the release is out to the public, the issue tracking the release shall be closed.
-
-## Fuzzing the parser
-
-Make sure you install cargo fuzz:
-
-```bash
-$ cargo install cargo-fuzz
-```
-
-```bash
-$ cd rust/kcl-lib
-
-# list the fuzz targets
-$ cargo fuzz list
-
-# run the parser fuzzer
-$ cargo +nightly fuzz run parser
-```
-
-For more information on fuzzing you can check out
-[this guide](https://rust-fuzz.github.io/book/cargo-fuzz.html).
-
-## Tests
-
-### Playwright tests
-
-You will need a `./e2e/playwright/playwright-secrets.env` file:
-
-```bash
-$ touch ./e2e/playwright/playwright-secrets.env
-$ cat ./e2e/playwright/playwright-secrets.env
-token=<dev.zoo.dev/account/api-tokens>
-snapshottoken=<zoo.dev/account/api-tokens>
-```
-or use `export` to set the environment variables `token` and `snapshottoken`.
-
-#### Snapshot tests (Google Chrome on Ubuntu only)
-
-Only Ubunu and Google Chrome is supported for the set of tests evaluating screenshot snapshots.
-If you don't run Ubuntu locally or in a VM, you may use a GitHub Codespace.
-```
-npm run playwright -- install chrome
-npm run test:snapshots
-```
-You may use `-- --update-snapshots` as needed.
-
-#### Electron flow tests (Chromium on Ubuntu, macOS, Windows)
-
-```
-npm run playwright -- install chromium
-npm run test:playwright:electron:local 
-```
-You may use `-- -g "my test"` to match specific test titles, or `-- path/to/file.spec.ts` for a test file.
-
-#### Debugger
-
-However, if you want a debugger I recommend using VSCode and the `playwright` extension, as the above command is a cruder debugger that steps into every function call which is annoying.
-With the extension you can set a breakpoint after `waitForDefaultPlanesVisibilityChange` in order to skip app loading, then the vscode debugger's "step over" is much better for being able to stay at the right level of abstraction as you debug the code.
-
-If you want to limit to a single browser use `--project="webkit"` or `firefox`, `Google Chrome`
-Or comment out browsers in `playwright.config.ts`.
-
-note chromium has encoder compat issues which is why were testing against the branded 'Google Chrome'
-
-You may consider using the VSCode extension, it's useful for running individual threads, but some some reason the "record a test" is locked to chromium with we can't use. A work around is to us the CI `npm run playwright codegen -b wk --load-storage ./store localhost:3000`
-
-<details>
-<summary>
-
-Where `./store` should look like this
-
-</summary>
-
-```JSON
-{
-  "cookies": [],
-  "origins": [
-    {
-      "origin": "http://localhost:3000",
-      "localStorage": [
-        {
-          "name": "store",
-          "value": "{\"state\":{\"openPanes\":[\"code\"]},\"version\":0}"
-        },
-        {
-          "name": "persistCode",
-          "value": ""
-        },
-        {
-          "name": "TOKEN_PERSIST_KEY",
-          "value": "your-token"
-        }
-      ]
-    }
-  ]
-}
-```
-
-</details>
-
-However because much of our tests involve clicking in the stream at specific locations, it's code-gen looks `await page.locator('video').click();` when really we need to use a pixel coord, so I think it's of limited use.
-
-### Unit and component tests
-
-If you already haven't, run the following:
-
-```
-npm
-npm run build:wasm
-npm start
-```
-
-and finally:
-
-```
-npm run test:unit
-```
-
-For individual testing:
-
-```
-npm run test abstractSyntaxTree -t "unexpected closed curly brace" --silent=false
-```
-
-Which will run our suite of [Vitest unit](https://vitest.dev/) and [React Testing Library E2E](https://testing-library.com/docs/react-testing-library/intro) tests, in interactive mode by default.
-
-### Rust tests
-
-**Dependencies**
-
-- `KITTYCAD_API_TOKEN`
-- `cargo-nextest`
-- `just`
-
-#### Setting KITTYCAD_API_TOKEN
-
-Use the production zoo.dev token, set this environment variable before running the tests
-
-#### Installing cargonextest
-
-```
-cd rust 
-cargo search cargo-nextest
-cargo install cargo-nextest
-```
-
-#### just
-
-install [`just`](https://github.com/casey/just?tab=readme-ov-file#pre-built-binaries)
-
-#### Running the tests
-
-```bash
-# With just
-# Make sure KITTYCAD_API_TOKEN=<prod zoo.dev token> is set
-# Make sure you installed cargo-nextest
-# Make sure you installed just
-cd rust 
-just test
-```
-
-```bash
-# Without just
-# Make sure KITTYCAD_API_TOKEN=<prod zoo.dev token> is set
-# Make sure you installed cargo-nextest
-cd rust 
-export RUST_BRACKTRACE="full" && cargo nextest run --workspace --test-threads=1
-```
-
-Where `XXX` is an API token from the production engine (NOT the dev environment).
-
-We recommend using [nextest](https://nexte.st/) to run the Rust tests (its faster and is used in CI). Once installed, run the tests using
-
-```
-cd rust 
-KITTYCAD_API_TOKEN=XXX cargo run nextest
-```
-
-### Mapping CI CD jobs to local commands
-
-When you see the CI CD fail on jobs you may wonder three things
-
-- Do I have a bug in my code?
-- Is the test flaky?
-- Is there a bug in `main`?
-
-To answer these questions the following commands will give you confidence to locate the issue.
-
-#### Static Analysis
-
-Part of the CI CD pipeline performs static analysis on the code. Use the following commands to mimic the CI CD jobs.
-
-The following set of commands should get us closer to one and done commands to instantly retest issues.
-
-```
-npm run test-setup
-```
-
-> Gotcha, are packages up to date and is the wasm built?
-
-```
-npm run tsc
-npm run fmt:check
-npm run lint
-npm run test:unit:local
-```
-
-> Gotcha: Our unit tests have integration tests in them. You need to run a localhost server to run the unit tests.
-
-#### E2E Tests
-
-**Playwright Electron**
-
-These E2E tests run in electron. There are tests that are skipped if they are ran in a windows, linux, or macos environment. We can use playwright tags to implement test skipping.
-
-```
-npm run test:playwright:electron:local
-npm run test:playwright:electron:windows:local
-npm run test:playwright:electron:macos:local
-npm run test:playwright:electron:ubuntu:local
-```
-
-> Why does it say local? The CI CD commands that run in the pipeline cannot be ran locally. A single command will not properly setup the testing environment locally.
-
-#### Some notes on CI
-
-The tests are broken into snapshot tests and non-snapshot tests, and they run in that order, they automatically commit new snap shots, so if you see an image commit check it was an intended change. If we have non-determinism in the snapshots such that they are always committing new images, hopefully this annoyance makes us fix them asap, if you notice this happening let Kurt know. But for the odd occasion `git reset --hard HEAD~ && git push -f` is your friend.
-
-How to interpret failing playwright tests?
-If your tests fail, click through to the action and see that the tests failed on a line that includes `await page.getByTestId('loading').waitFor({ state: 'detached' })`, this means the test fail because the stream never started. It's you choice if you want to re-run the test, or ignore the failure.
-
-We run on ubuntu and macos, because safari doesn't work on linux because of the dreaded "no RTCPeerConnection variable" error. But linux runs first and then macos for the same reason that we limit the number of parallel tests to 1 because we limit stream connections per user, so tests would start failing we if let them run together.
-
-If something fails on CI you can download the artifact, unzip it and then open `playwright-report/data/<UUID>.zip` with https://trace.playwright.dev/ to see what happened.
-
-#### Getting started writing a playwright test in our app
-
-Besides following the instructions above and using the playwright docs, our app is weird because of the whole stream thing, which means our testing is weird. Because we've just figured out this stuff and therefore docs might go stale quick here's a 15min vid/tutorial
-
-https://github.com/KittyCAD/modeling-app/assets/29681384/6f5e8e85-1003-4fd9-be7f-f36ce833942d
-
-<details>
-
-<summary>
-PS: for the debug panel, the following JSON is useful for snapping the camera
-</summary>
-
-```JSON
-{"type":"modeling_cmd_req","cmd_id":"054e5472-e5e9-4071-92d7-1ce3bac61956","cmd":{"type":"default_camera_look_at","center":{"x":15,"y":0,"z":0},"up":{"x":0,"y":0,"z":1},"vantage":{"x":30,"y":30,"z":30}}}
-```
-
-</details>
 
 ## KCL
 
-For how to contribute to KCL, [see our KCL README](https://github.com/KittyCAD/modeling-app/tree/main/rust/kcl-lib).
+To contribute to the KittyCAD Language, see the [README](https://github.com/KittyCAD/modeling-app/tree/main/rust/kcl-lib) for KCL.
-
-### Logging
-
-To display logging (to the terminal or console) set `ZOO_LOG=1`. This will log some warnings and simple performance metrics. To view these in test runs, use `-- --nocapture`.
-
-To enable memory metrics, build with `--features dhat-heap`.

docs/kcl/angledLine.md

@@ -8,17 +8,17 @@ Draw a line segment relative to the current origin using the polar measure of so
 
 
 
-```js
+```kcl
 angledLine(
-  sketch: Sketch,
+  sketch: [Sketch](/docs/kcl/types/Sketch),
-  angle: number,
+  angle: [number](/docs/kcl/types/number),
-  length?: number,
+  length?: [number](/docs/kcl/types/number),
-  lengthX?: number,
+  lengthX?: [number](/docs/kcl/types/number),
-  lengthY?: number,
+  lengthY?: [number](/docs/kcl/types/number),
-  endAbsoluteX?: number,
+  endAbsoluteX?: [number](/docs/kcl/types/number),
-  endAbsoluteY?: number,
+  endAbsoluteY?: [number](/docs/kcl/types/number),
-  tag?: TagDeclarator,
+  tag?: [TagDeclarator](/docs/kcl/types#tag-declaration),
-): Sketch
+): [Sketch](/docs/kcl/types/Sketch)
 ```
 
 
@@ -33,7 +33,7 @@ angledLine(
 | `lengthY` | [`number`](/docs/kcl/types/number) | Draw the line this distance along the Y axis. Only one of `length`, `lengthX`, `lengthY`, `endAbsoluteX`, `endAbsoluteY` can be given. | No |
 | `endAbsoluteX` | [`number`](/docs/kcl/types/number) | Draw the line along the given angle until it reaches this point along the X axis. Only one of `length`, `lengthX`, `lengthY`, `endAbsoluteX`, `endAbsoluteY` can be given. | No |
 | `endAbsoluteY` | [`number`](/docs/kcl/types/number) | Draw the line along the given angle until it reaches this point along the Y axis. Only one of `length`, `lengthX`, `lengthY`, `endAbsoluteX`, `endAbsoluteY` can be given. | No |
-| [`tag`](/docs/kcl/types/tag) | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Create a new tag which refers to this line | No |
+| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Create a new tag which refers to this line | No |
 
 ### Returns
 
@@ -42,9 +42,9 @@ angledLine(
 
 ### Examples
 
-```js
+```kcl
 exampleSketch = startSketchOn(XZ)
-  |> startProfileAt([0, 0], %)
+  |> startProfile(at = [0, 0])
   |> yLine(endAbsolute = 15)
   |> angledLine(angle = 30, length = 15)
   |> line(end = [8, -10])

docs/kcl/angledLineThatIntersects.md

@@ -8,14 +8,14 @@ Draw an angled line from the current origin, constructing a line segment such th
 
 
 
-```js
+```kcl
 angledLineThatIntersects(
-  sketch: Sketch,
+  sketch: [Sketch](/docs/kcl/types/Sketch),
-  angle: number,
+  angle: [number](/docs/kcl/types/number),
-  intersectTag: TagIdentifier,
+  intersectTag: [TagIdentifier](/docs/kcl/types#tag-identifier),
-  offset?: number,
+  offset?: [number](/docs/kcl/types/number),
-  tag?: TagDeclarator,
+  tag?: [TagDeclarator](/docs/kcl/types#tag-declaration),
-): Sketch
+): [Sketch](/docs/kcl/types/Sketch)
 ```
 
 
@@ -27,7 +27,7 @@ angledLineThatIntersects(
 | `angle` | [`number`](/docs/kcl/types/number) | Which angle should the line be drawn at? | Yes |
 | `intersectTag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | The tag of the line to intersect with | Yes |
 | `offset` | [`number`](/docs/kcl/types/number) | The offset from the intersecting line. Defaults to 0. | No |
-| [`tag`](/docs/kcl/types/tag) | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Create a new tag which refers to this line | No |
+| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Create a new tag which refers to this line | No |
 
 ### Returns
 
@@ -36,9 +36,9 @@ angledLineThatIntersects(
 
 ### Examples
 
-```js
+```kcl
 exampleSketch = startSketchOn(XZ)
-  |> startProfileAt([0, 0], %)
+  |> startProfile(at = [0, 0])
   |> line(endAbsolute = [5, 10])
   |> line(endAbsolute = [-10, 10], tag = $lineToIntersect)
   |> line(endAbsolute = [0, 20])

docs/kcl/bezierCurve.md

@@ -8,12 +8,14 @@ Draw a smooth, continuous, curved line segment from the current origin to the de
 
 
 
-```js
+```kcl
 bezierCurve(
-  data: BezierData,
+  sketch: [Sketch](/docs/kcl/types/Sketch),
-  sketch: Sketch,
+  control1: [[[number](/docs/kcl/types/number)]](/docs/kcl/types/[number](/docs/kcl/types/number)),
-  tag?: TagDeclarator,
+  control2: [[[number](/docs/kcl/types/number)]](/docs/kcl/types/[number](/docs/kcl/types/number)),
-): Sketch
+  end: [[[number](/docs/kcl/types/number)]](/docs/kcl/types/[number](/docs/kcl/types/number)),
+  tag?: [TagDeclarator](/docs/kcl/types#tag-declaration),
+): [Sketch](/docs/kcl/types/Sketch)
 ```
 
 
@@ -21,9 +23,11 @@ bezierCurve(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `data` | [`BezierData`](/docs/kcl/types/BezierData) | Data to draw a bezier curve. | Yes |
+| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | Which sketch should this path be added to? | Yes |
-| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) |  | Yes |
+| `control1` | [`[number]`](/docs/kcl/types/number) | First control point for the cubic | Yes |
-| [`tag`](/docs/kcl/types/tag) | [`TagDeclarator`](/docs/kcl/types#tag-declaration) |  | No |
+| `control2` | [`[number]`](/docs/kcl/types/number) | Second control point for the cubic | Yes |
+| `end` | [`[number]`](/docs/kcl/types/number) | How far away (along the X and Y axes) should this line go? | Yes |
+| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Create a new tag which refers to this line | No |
 
 ### Returns
 
@@ -32,15 +36,11 @@ bezierCurve(
 
 ### Examples
 
-```js
+```kcl
 exampleSketch = startSketchOn(XZ)
-  |> startProfileAt([0, 0], %)
+  |> startProfile(at = [0, 0])
   |> line(end = [0, 10])
-  |> bezierCurve({
+  |> bezierCurve(control1 = [5, 0], control2 = [5, 10], end = [10, 10])
-       to = [10, 10],
-       control1 = [5, 0],
-       control2 = [5, 10]
-     }, %)
   |> line(endAbsolute = [10, 0])
   |> close()
 

docs/kcl/circleThreePoint.md

@@ -8,14 +8,14 @@ Construct a circle derived from 3 points.
 
 
 
-```js
+```kcl
 circleThreePoint(
-  sketchSurfaceOrGroup: SketchOrSurface,
+  sketchSurfaceOrGroup: [[Sketch](/docs/kcl/types/Sketch)OrSurface](/docs/kcl/types/[Sketch](/docs/kcl/types/Sketch)OrSurface),
-  p1: [number],
+  p1: [[[number](/docs/kcl/types/number)]](/docs/kcl/types/[number](/docs/kcl/types/number)),
-  p2: [number],
+  p2: [[[number](/docs/kcl/types/number)]](/docs/kcl/types/[number](/docs/kcl/types/number)),
-  p3: [number],
+  p3: [[[number](/docs/kcl/types/number)]](/docs/kcl/types/[number](/docs/kcl/types/number)),
-  tag?: TagDeclarator,
+  tag?: [TagDeclarator](/docs/kcl/types#tag-declaration),
-): Sketch
+): [Sketch](/docs/kcl/types/Sketch)
 ```
 
 
@@ -27,7 +27,7 @@ circleThreePoint(
 | `p1` | [`[number]`](/docs/kcl/types/number) | 1st point to derive the circle. | Yes |
 | `p2` | [`[number]`](/docs/kcl/types/number) | 2nd point to derive the circle. | Yes |
 | `p3` | [`[number]`](/docs/kcl/types/number) | 3rd point to derive the circle. | Yes |
-| [`tag`](/docs/kcl/types/tag) | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Identifier for the circle to reference elsewhere. | No |
+| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Identifier for the circle to reference elsewhere. | No |
 
 ### Returns
 
@@ -36,7 +36,7 @@ circleThreePoint(
 
 ### Examples
 
-```js
+```kcl
 exampleSketch = startSketchOn(XY)
   |> circleThreePoint(p1 = [10, 10], p2 = [20, 8], p3 = [15, 5])
   |> extrude(length = 5)

docs/kcl/consts/std-END.md

@@ -8,7 +8,7 @@ Identifies the ending face of an extrusion. I.e., the new face created by an ext
 
 
 
-```js
+```kcl
 std::END: string = 'end'
 ```
 

docs/kcl/consts/std-START.md

@@ -8,7 +8,7 @@ Identifies the starting face of an extrusion. I.e., the face which is extruded.
 
 
 
-```js
+```kcl
 std::START: string = 'start'
 ```
 

docs/kcl/consts/std-X.md

@@ -8,7 +8,7 @@ layout: manual
 
 
 
-```js
+```kcl
 std::X
 ```
 

docs/kcl/consts/std-XY.md

@@ -8,7 +8,7 @@ layout: manual
 
 
 
-```js
+```kcl
 std::XY
 ```
 

docs/kcl/consts/std-XZ.md

@@ -8,7 +8,7 @@ layout: manual
 
 
 
-```js
+```kcl
 std::XZ
 ```
 

docs/kcl/consts/std-Y.md

@@ -8,7 +8,7 @@ layout: manual
 
 
 
-```js
+```kcl
 std::Y
 ```
 

docs/kcl/consts/std-YZ.md

@@ -8,7 +8,7 @@ layout: manual
 
 
 
-```js
+```kcl
 std::YZ
 ```
 

docs/kcl/consts/std-Z.md

@@ -8,7 +8,7 @@ layout: manual
 
 
 
-```js
+```kcl
 std::Z
 ```
 

docs/kcl/consts/std-math-E.md

@@ -8,15 +8,15 @@ The value of Euler’s number `e`.
 
 
 
-```js
+```kcl
 std::math::E: number = 2.71828182845904523536028747135266250_
 ```
 
 ### Examples
 
-```js
+```kcl
 exampleSketch = startSketchOn(XZ)
-  |> startProfileAt([0, 0], %)
+  |> startProfile(at = [0, 0])
   |> angledLine(
     angle = 30,
     length = 2 * E ^ 2,

docs/kcl/consts/std-math-PI.md

@@ -8,17 +8,17 @@ The value of `pi`, Archimedes’ constant (π).
 
 
 
-```js
+```kcl
-std::math::PI: number = 3.14159265358979323846264338327950288_
+std::math::PI: number(_?) = 3.14159265358979323846264338327950288_?
 ```
 
 ### Examples
 
-```js
+```kcl
 circumference = 70
 
 exampleSketch = startSketchOn(XZ)
- |> circle(center = [0, 0], radius = circumference / (2 * PI))
+ |> circle(center = [0, 0], radius = (circumference / (2 * PI)): number(mm))
 
 example = extrude(exampleSketch, length = 5)
 ```

docs/kcl/consts/std-math-TAU.md

@@ -8,15 +8,15 @@ The value of `tau`, the full circle constant (τ). Equal to 2π.
 
 
 
-```js
+```kcl
 std::math::TAU: number = 6.28318530717958647692528676655900577_
 ```
 
 ### Examples
 
-```js
+```kcl
 exampleSketch = startSketchOn(XZ)
-  |> startProfileAt([0, 0], %)
+  |> startProfile(at = [0, 0])
   |> angledLine(
     angle = 50,
     length = 10 * TAU,

docs/kcl/consts/std-turns-HALF_TURN.md

@@ -8,7 +8,7 @@ layout: manual
 
 
 
-```js
+```kcl
 std::turns::HALF_TURN: number(deg) = 180deg
 ```
 

docs/kcl/consts/std-turns-QUARTER_TURN.md

@@ -8,7 +8,7 @@ layout: manual
 
 
 
-```js
+```kcl
 std::turns::QUARTER_TURN: number(deg) = 90deg
 ```
 

docs/kcl/consts/std-turns-THREE_QUARTER_TURN.md

@@ -8,7 +8,7 @@ layout: manual
 
 
 
-```js
+```kcl
 std::turns::THREE_QUARTER_TURN: number(deg) = 270deg
 ```
 

docs/kcl/consts/std-turns-ZERO.md

@@ -8,7 +8,7 @@ layout: manual
 
 
 
-```js
+```kcl
 std::turns::ZERO: number = 0
 ```
 

docs/kcl/e.md

@@ -29,7 +29,7 @@ e(): number
 
 ```js
 exampleSketch = startSketchOn(XZ)
-  |> startProfileAt([0, 0], %)
+  |> startProfile(at = [0, 0])
   |> angledLine(angle = 30, length = 2 * e() ^ 2)
   |> yLine(endAbsolute = 0)
   |> close()

docs/kcl/fromCm.md

@@ -4,8 +4,12 @@ excerpt: "Converts a number from centimeters to the current default unit."
 layout: manual
 ---
 
+**WARNING:** This function is deprecated.
+
 Converts a number from centimeters to the current default unit.
 
+*DEPRECATED* prefer using explicit numeric suffixes (e.g., `42cm`) or the `to...` conversion functions.
+
 No matter what units the current file uses, this function will always return a number equivalent to the input in centimeters.
 
 For example, if the current file uses inches, `fromCm(1)` will return `0.393701`. If the current file uses millimeters, `fromCm(1)` will return `10`. If the current file uses centimeters, `fromCm(1)` will return `1`.

docs/kcl/fromFt.md

@@ -4,8 +4,12 @@ excerpt: "Converts a number from feet to the current default unit."
 layout: manual
 ---
 
+**WARNING:** This function is deprecated.
+
 Converts a number from feet to the current default unit.
 
+*DEPRECATED* prefer using explicit numeric suffixes (e.g., `42ft`) or the `to...` conversion functions.
+
 No matter what units the current file uses, this function will always return a number equivalent to the input in feet.
 
 For example, if the current file uses inches, `fromFt(1)` will return `12`. If the current file uses millimeters, `fromFt(1)` will return `304.8`. If the current file uses feet, `fromFt(1)` will return `1`.

docs/kcl/fromInches.md

@@ -4,8 +4,12 @@ excerpt: "Converts a number from inches to the current default unit."
 layout: manual
 ---
 
+**WARNING:** This function is deprecated.
+
 Converts a number from inches to the current default unit.
 
+*DEPRECATED* prefer using explicit numeric suffixes (e.g., `42inch`) or the `to...` conversion functions.
+
 No matter what units the current file uses, this function will always return a number equivalent to the input in inches.
 
 For example, if the current file uses inches, `fromInches(1)` will return `1`. If the current file uses millimeters, `fromInches(1)` will return `25.4`.

docs/kcl/fromM.md

@@ -4,8 +4,12 @@ excerpt: "Converts a number from meters to the current default unit."
 layout: manual
 ---
 
+**WARNING:** This function is deprecated.
+
 Converts a number from meters to the current default unit.
 
+*DEPRECATED* prefer using explicit numeric suffixes (e.g., `42m`) or the `to...` conversion functions.
+
 No matter what units the current file uses, this function will always return a number equivalent to the input in meters.
 
 For example, if the current file uses inches, `fromM(1)` will return `39.3701`. If the current file uses millimeters, `fromM(1)` will return `1000`. If the current file uses meters, `fromM(1)` will return `1`.

docs/kcl/fromMm.md

@@ -4,8 +4,12 @@ excerpt: "Converts a number from mm to the current default unit."
 layout: manual
 ---
 
+**WARNING:** This function is deprecated.
+
 Converts a number from mm to the current default unit.
 
+*DEPRECATED* prefer using explicit numeric suffixes (e.g., `42mm`) or the `to...` conversion functions.
+
 No matter what units the current file uses, this function will always return a number equivalent to the input in millimeters.
 
 For example, if the current file uses inches, `fromMm(1)` will return `1/25.4`. If the current file uses millimeters, `fromMm(1)` will return `1`.

docs/kcl/fromYd.md

@@ -4,8 +4,12 @@ excerpt: "Converts a number from yards to the current default unit."
 layout: manual
 ---
 
+**WARNING:** This function is deprecated.
+
 Converts a number from yards to the current default unit.
 
+*DEPRECATED* prefer using explicit numeric suffixes (e.g., `42yd`) or the `to...` conversion functions.
+
 No matter what units the current file uses, this function will always return a number equivalent to the input in yards.
 
 For example, if the current file uses inches, `fromYd(1)` will return `36`. If the current file uses millimeters, `fromYd(1)` will return `914.4`. If the current file uses yards, `fromYd(1)` will return `1`.

docs/kcl/getCommonEdge.md

@@ -8,8 +8,8 @@ Get the shared edge between two faces.
 
 
 
-```js
+```kcl
-getCommonEdge(faces: [TagIdentifier]): Uuid
+getCommon[Edge](/docs/kcl/types/Edge)(faces: [[TagIdentifier](/docs/kcl/types#tag-identifier)]): Uuid
 ```
 
 
@@ -26,13 +26,13 @@ getCommonEdge(faces: [TagIdentifier]): Uuid
 
 ### Examples
 
-```js
+```kcl
 // Get an edge shared between two faces, created after a chamfer.
 
 
 scale = 20
 part001 = startSketchOn(XY)
-  |> startProfileAt([0, 0], %)
+  |> startProfile(at = [0, 0])
   |> line(end = [0, scale])
   |> line(end = [scale, 0])
   |> line(end = [0, -scale])

docs/kcl/getNextAdjacentEdge.md

@@ -8,8 +8,8 @@ Get the next adjacent edge to the edge given.
 
 
 
-```js
+```kcl
-getNextAdjacentEdge(tag: TagIdentifier): Uuid
+getNextAdjacent[Edge](/docs/kcl/types/Edge)(edge: [TagIdentifier](/docs/kcl/types#tag-identifier)): Uuid
 ```
 
 
@@ -17,7 +17,7 @@ getNextAdjacentEdge(tag: TagIdentifier): Uuid
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| [`tag`](/docs/kcl/types/tag) | [`TagIdentifier`](/docs/kcl/types#tag-identifier) |  | Yes |
+| `edge` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | The tag of the edge you want to find the next adjacent edge of. | Yes |
 
 ### Returns
 
@@ -26,9 +26,9 @@ getNextAdjacentEdge(tag: TagIdentifier): Uuid
 
 ### Examples
 
-```js
+```kcl
 exampleSketch = startSketchOn(XZ)
-  |> startProfileAt([0, 0], %)
+  |> startProfile(at = [0, 0])
   |> line(end = [10, 0])
   |> angledLine(angle = 60, length = 10)
   |> angledLine(angle = 120, length = 10)

docs/kcl/getOppositeEdge.md

@@ -8,8 +8,8 @@ Get the opposite edge to the edge given.
 
 
 
-```js
+```kcl
-getOppositeEdge(tag: TagIdentifier): Uuid
+getOpposite[Edge](/docs/kcl/types/Edge)(edge: [TagIdentifier](/docs/kcl/types#tag-identifier)): Uuid
 ```
 
 
@@ -17,7 +17,7 @@ getOppositeEdge(tag: TagIdentifier): Uuid
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| [`tag`](/docs/kcl/types/tag) | [`TagIdentifier`](/docs/kcl/types#tag-identifier) |  | Yes |
+| `edge` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | The tag of the edge you want to find the opposite edge of. | Yes |
 
 ### Returns
 
@@ -26,9 +26,9 @@ getOppositeEdge(tag: TagIdentifier): Uuid
 
 ### Examples
 
-```js
+```kcl
 exampleSketch = startSketchOn(XZ)
-  |> startProfileAt([0, 0], %)
+  |> startProfile(at = [0, 0])
   |> line(end = [10, 0])
   |> angledLine(angle = 60, length = 10)
   |> angledLine(angle = 120, length = 10)

docs/kcl/getPreviousAdjacentEdge.md

@@ -8,8 +8,8 @@ Get the previous adjacent edge to the edge given.
 
 
 
-```js
+```kcl
-getPreviousAdjacentEdge(tag: TagIdentifier): Uuid
+getPreviousAdjacent[Edge](/docs/kcl/types/Edge)(edge: [TagIdentifier](/docs/kcl/types#tag-identifier)): Uuid
 ```
 
 
@@ -17,7 +17,7 @@ getPreviousAdjacentEdge(tag: TagIdentifier): Uuid
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| [`tag`](/docs/kcl/types/tag) | [`TagIdentifier`](/docs/kcl/types#tag-identifier) |  | Yes |
+| `edge` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | The tag of the edge you want to find the previous adjacent edge of. | Yes |
 
 ### Returns
 
@@ -26,9 +26,9 @@ getPreviousAdjacentEdge(tag: TagIdentifier): Uuid
 
 ### Examples
 
-```js
+```kcl
 exampleSketch = startSketchOn(XZ)
-  |> startProfileAt([0, 0], %)
+  |> startProfile(at = [0, 0])
   |> line(end = [10, 0])
   |> angledLine(angle = 60, length = 10)
   |> angledLine(angle = 120, length = 10)

docs/kcl/index.md

@@ -22,63 +22,30 @@ layout: manual
   * [`string`](kcl/types/string)
   * [`tag`](kcl/types/tag)
 * **std**
-  * [`Axis2d`](kcl/types/Axis2d)
-  * [`Axis3d`](kcl/types/Axis3d)
   * [`END`](kcl/consts/std-END)
-  * [`Edge`](kcl/types/Edge)
-  * [`Face`](kcl/types/Face)
-  * [`Helix`](kcl/types/Helix)
-  * [`Plane`](kcl/types/Plane)
-  * [`Point2d`](kcl/types/Point2d)
-  * [`Point3d`](kcl/types/Point3d)
   * [`START`](kcl/consts/std-START)
-  * [`Sketch`](kcl/types/Sketch)
-  * [`Solid`](kcl/types/Solid)
   * [`X`](kcl/consts/std-X)
   * [`XY`](kcl/consts/std-XY)
   * [`XZ`](kcl/consts/std-XZ)
   * [`Y`](kcl/consts/std-Y)
   * [`YZ`](kcl/consts/std-YZ)
   * [`Z`](kcl/consts/std-Z)
-  * [`abs`](kcl/abs)
-  * [`acos`](kcl/acos)
-  * [`angleToMatchLengthX`](kcl/angleToMatchLengthX)
-  * [`angleToMatchLengthY`](kcl/angleToMatchLengthY)
   * [`angledLine`](kcl/angledLine)
   * [`angledLineThatIntersects`](kcl/angledLineThatIntersects)
   * [`appearance`](kcl/appearance)
   * [`arc`](kcl/arc)
-  * [`arcTo`](kcl/arcTo)
-  * [`asin`](kcl/asin)
   * [`assert`](kcl/assert)
-  * [`assertEqual`](kcl/assertEqual)
+  * [`assertIs`](kcl/assertIs)
-  * [`assertGreaterThan`](kcl/assertGreaterThan)
-  * [`assertGreaterThanOrEq`](kcl/assertGreaterThanOrEq)
-  * [`assertLessThan`](kcl/assertLessThan)
-  * [`assertLessThanOrEq`](kcl/assertLessThanOrEq)
-  * [`atan`](kcl/atan)
-  * [`atan2`](kcl/atan2)
   * [`bezierCurve`](kcl/bezierCurve)
-  * [`ceil`](kcl/ceil)
-  * [`chamfer`](kcl/chamfer)
   * [`circleThreePoint`](kcl/circleThreePoint)
+  * [`clone`](kcl/clone)
   * [`close`](kcl/close)
   * [`extrude`](kcl/extrude)
-  * [`fillet`](kcl/fillet)
-  * [`floor`](kcl/floor)
-  * [`fromCm`](kcl/fromCm)
-  * [`fromFt`](kcl/fromFt)
-  * [`fromInches`](kcl/fromInches)
-  * [`fromM`](kcl/fromM)
-  * [`fromMm`](kcl/fromMm)
-  * [`fromYd`](kcl/fromYd)
   * [`getCommonEdge`](kcl/getCommonEdge)
   * [`getNextAdjacentEdge`](kcl/getNextAdjacentEdge)
   * [`getOppositeEdge`](kcl/getOppositeEdge)
   * [`getPreviousAdjacentEdge`](kcl/getPreviousAdjacentEdge)
   * [`helix`](kcl/std-helix)
-  * [`hole`](kcl/hole)
-  * [`hollow`](kcl/hollow)
   * [`intersect`](kcl/intersect)
   * [`involuteCircular`](kcl/involuteCircular)
   * [`lastSegX`](kcl/lastSegX)
@@ -87,15 +54,9 @@ layout: manual
   * [`legAngY`](kcl/legAngY)
   * [`legLen`](kcl/legLen)
   * [`line`](kcl/line)
-  * [`ln`](kcl/ln)
   * [`loft`](kcl/loft)
-  * [`log`](kcl/log)
-  * [`log10`](kcl/log10)
-  * [`log2`](kcl/log2)
   * [`map`](kcl/map)
-  * [`max`](kcl/max)
+  * [`offsetPlane`](kcl/std-offsetPlane)
-  * [`min`](kcl/min)
-  * [`offsetPlane`](kcl/offsetPlane)
   * [`patternCircular2d`](kcl/patternCircular2d)
   * [`patternCircular3d`](kcl/patternCircular3d)
   * [`patternLinear2d`](kcl/patternLinear2d)
@@ -104,16 +65,13 @@ layout: manual
   * [`patternTransform2d`](kcl/patternTransform2d)
   * [`polygon`](kcl/polygon)
   * [`pop`](kcl/pop)
-  * [`pow`](kcl/pow)
   * [`profileStart`](kcl/profileStart)
   * [`profileStartX`](kcl/profileStartX)
   * [`profileStartY`](kcl/profileStartY)
   * [`push`](kcl/push)
   * [`reduce`](kcl/reduce)
-  * [`rem`](kcl/rem)
   * [`revolve`](kcl/std-revolve)
   * [`rotate`](kcl/rotate)
-  * [`round`](kcl/round)
   * [`scale`](kcl/scale)
   * [`segAng`](kcl/segAng)
   * [`segEnd`](kcl/segEnd)
@@ -123,16 +81,13 @@ layout: manual
   * [`segStart`](kcl/segStart)
   * [`segStartX`](kcl/segStartX)
   * [`segStartY`](kcl/segStartY)
-  * [`shell`](kcl/shell)
+  * [`startProfile`](kcl/startProfile)
-  * [`sqrt`](kcl/sqrt)
-  * [`startProfileAt`](kcl/startProfileAt)
   * [`startSketchOn`](kcl/startSketchOn)
   * [`subtract`](kcl/subtract)
+  * [`subtract2d`](kcl/subtract2d)
   * [`sweep`](kcl/sweep)
   * [`tangentToEnd`](kcl/tangentToEnd)
   * [`tangentialArc`](kcl/tangentialArc)
-  * [`toDegrees`](kcl/toDegrees)
-  * [`toRadians`](kcl/toRadians)
   * [`translate`](kcl/translate)
   * [`union`](kcl/union)
   * [`xLine`](kcl/xLine)
@@ -141,15 +96,57 @@ layout: manual
   * [`E`](kcl/consts/std-math-E)
   * [`PI`](kcl/consts/std-math-PI)
   * [`TAU`](kcl/consts/std-math-TAU)
+  * [`abs`](kcl/std-math-abs)
+  * [`acos`](kcl/std-math-acos)
+  * [`asin`](kcl/std-math-asin)
+  * [`atan`](kcl/std-math-atan)
+  * [`atan2`](kcl/std-math-atan2)
+  * [`ceil`](kcl/std-math-ceil)
   * [`cos`](kcl/std-math-cos)
+  * [`floor`](kcl/std-math-floor)
+  * [`ln`](kcl/std-math-ln)
+  * [`log`](kcl/std-math-log)
+  * [`log10`](kcl/std-math-log10)
+  * [`log2`](kcl/std-math-log2)
+  * [`max`](kcl/std-math-max)
+  * [`min`](kcl/std-math-min)
   * [`polar`](kcl/std-math-polar)
+  * [`pow`](kcl/std-math-pow)
+  * [`rem`](kcl/std-math-rem)
+  * [`round`](kcl/std-math-round)
   * [`sin`](kcl/std-math-sin)
+  * [`sqrt`](kcl/std-math-sqrt)
   * [`tan`](kcl/std-math-tan)
 * **std::sketch**
   * [`circle`](kcl/std-sketch-circle)
   * [`mirror2d`](kcl/std-sketch-mirror2d)
+* **std::solid**
+  * [`chamfer`](kcl/std-solid-chamfer)
+  * [`fillet`](kcl/std-solid-fillet)
+  * [`hollow`](kcl/std-solid-hollow)
+  * [`shell`](kcl/std-solid-shell)
 * **std::turns**
   * [`turns::HALF_TURN`](kcl/consts/std-turns-HALF_TURN)
   * [`turns::QUARTER_TURN`](kcl/consts/std-turns-QUARTER_TURN)
   * [`turns::THREE_QUARTER_TURN`](kcl/consts/std-turns-THREE_QUARTER_TURN)
   * [`turns::ZERO`](kcl/consts/std-turns-ZERO)
+* **std::types**
+  * [`Axis2d`](kcl/types/Axis2d)
+  * [`Axis3d`](kcl/types/Axis3d)
+  * [`Edge`](kcl/types/Edge)
+  * [`Face`](kcl/types/Face)
+  * [`Helix`](kcl/types/Helix)
+  * [`Plane`](kcl/types/Plane)
+  * [`Point2d`](kcl/types/Point2d)
+  * [`Point3d`](kcl/types/Point3d)
+  * [`Sketch`](kcl/types/Sketch)
+  * [`Solid`](kcl/types/Solid)
+* **std::units**
+  * [`units::toCentimeters`](kcl/std-units-toCentimeters)
+  * [`units::toDegrees`](kcl/std-units-toDegrees)
+  * [`units::toFeet`](kcl/std-units-toFeet)
+  * [`units::toInches`](kcl/std-units-toInches)
+  * [`units::toMeters`](kcl/std-units-toMeters)
+  * [`units::toMillimeters`](kcl/std-units-toMillimeters)
+  * [`units::toRadians`](kcl/std-units-toRadians)
+  * [`units::toYards`](kcl/std-units-toYards)

docs/kcl/int.md

@@ -34,7 +34,7 @@ int(num: number): number
 
 ```js
 n = int(ceil(5 / 2))
-assertEqual(n, 3, 0.0001, "5/2 = 2.5, rounded up makes 3")
+assert(n, isEqualTo = 3, error = "5/2 = 2.5, rounded up makes 3")
 // Draw n cylinders.
 startSketchOn(XZ)
   |> circle(center = [0, 0], radius = 2)

docs/kcl/involuteCircular.md

@@ -8,15 +8,15 @@ Extend the current sketch with a new involute circular curve.
 
 
 
-```js
+```kcl
 involuteCircular(
-  sketch: Sketch,
+  sketch: [Sketch](/docs/kcl/types/Sketch),
-  startRadius: number,
+  startRadius: [number](/docs/kcl/types/number),
-  endRadius: number,
+  endRadius: [number](/docs/kcl/types/number),
-  angle: number,
+  angle: [number](/docs/kcl/types/number),
-  reverse?: bool,
+  reverse?: [bool](/docs/kcl/types/bool),
-  tag?: TagDeclarator,
+  tag?: [TagDeclarator](/docs/kcl/types#tag-declaration),
-): Sketch
+): [Sketch](/docs/kcl/types/Sketch)
 ```
 
 
@@ -29,7 +29,7 @@ involuteCircular(
 | `endRadius` | [`number`](/docs/kcl/types/number) | The involute is described between two circles, end_radius is the radius of the outer circle. | Yes |
 | `angle` | [`number`](/docs/kcl/types/number) | The angle to rotate the involute by. A value of zero will produce a curve with a tangent along the x-axis at the start point of the curve. | Yes |
 | `reverse` | [`bool`](/docs/kcl/types/bool) | If reverse is true, the segment will start from the end of the involute, otherwise it will start from that start. Defaults to false. | No |
-| [`tag`](/docs/kcl/types/tag) | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Create a new tag which refers to this line | No |
+| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Create a new tag which refers to this line | No |
 
 ### Returns
 
@@ -38,11 +38,11 @@ involuteCircular(
 
 ### Examples
 
-```js
+```kcl
 a = 10
 b = 14
 startSketchOn(XZ)
-  |> startProfileAt([0, 0], %)
+  |> startProfile(at = [0, 0])
   |> involuteCircular(startRadius = a, endRadius = b, angle = 60)
   |> involuteCircular(
        startRadius = a,

docs/kcl/known-issues.md

@@ -21,4 +21,6 @@ once fixed in engine will just start working here with no language changes.
 - **Chamfers**: Chamfers cannot intersect, you will get an error. Only simple
     chamfer cases work currently.
 
-- **Appearance**: Changing the appearance on a loft does not work.
+- **Appearance**: Changing the appearance on a loft does not work. 
+
+- **CSG Booleans**: Coplanar (bodies that share a plane) unions, subtractions, and intersections are not currently supported.

docs/kcl/lastSegX.md

@@ -8,8 +8,8 @@ Extract the 'x' axis value of the last line segment in the provided 2-d sketch.
 
 
 
-```js
+```kcl
-lastSegX(sketch: Sketch): number
+lastSegX(sketch: [Sketch](/docs/kcl/types/Sketch)): [number](/docs/kcl/types/number)
 ```
 
 
@@ -26,9 +26,9 @@ lastSegX(sketch: Sketch): number
 
 ### Examples
 
-```js
+```kcl
 exampleSketch = startSketchOn(XZ)
-  |> startProfileAt([0, 0], %)
+  |> startProfile(at = [0, 0])
   |> line(end = [5, 0])
   |> line(end = [20, 5])
   |> line(end = [lastSegX(%), 0])

docs/kcl/lastSegY.md

@@ -8,8 +8,8 @@ Extract the 'y' axis value of the last line segment in the provided 2-d sketch.
 
 
 
-```js
+```kcl
-lastSegY(sketch: Sketch): number
+lastSegY(sketch: [Sketch](/docs/kcl/types/Sketch)): [number](/docs/kcl/types/number)
 ```
 
 
@@ -26,9 +26,9 @@ lastSegY(sketch: Sketch): number
 
 ### Examples
 
-```js
+```kcl
 exampleSketch = startSketchOn(XZ)
-  |> startProfileAt([0, 0], %)
+  |> startProfile(at = [0, 0])
   |> line(end = [5, 0])
   |> line(end = [20, 5])
   |> line(end = [0, lastSegY(%)])

docs/kcl/legAngX.md

@@ -8,11 +8,11 @@ Compute the angle of the given leg for x.
 
 
 
-```js
+```kcl
 legAngX(
-  hypotenuse: number,
+  hypotenuse: [number](/docs/kcl/types/number),
-  leg: number,
+  leg: [number](/docs/kcl/types/number),
-): number
+): [number](/docs/kcl/types/number)
 ```
 
 ### Tags
@@ -24,8 +24,8 @@ legAngX(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `hypotenuse` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `hypotenuse` | [`number`](/docs/kcl/types/number) | The length of the triangle's hypotenuse | Yes |
-| `leg` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `leg` | [`number`](/docs/kcl/types/number) | The length of one of the triangle's legs (i.e. non-hypotenuse side) | Yes |
 
 ### Returns
 
@@ -34,8 +34,8 @@ legAngX(
 
 ### Examples
 
-```js
+```kcl
-legAngX(5, 3)
+legAngX(hypotenuse = 5, leg = 3)
 ```
 
 

docs/kcl/legAngY.md

@@ -8,11 +8,11 @@ Compute the angle of the given leg for y.
 
 
 
-```js
+```kcl
 legAngY(
-  hypotenuse: number,
+  hypotenuse: [number](/docs/kcl/types/number),
-  leg: number,
+  leg: [number](/docs/kcl/types/number),
-): number
+): [number](/docs/kcl/types/number)
 ```
 
 ### Tags
@@ -24,8 +24,8 @@ legAngY(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `hypotenuse` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `hypotenuse` | [`number`](/docs/kcl/types/number) | The length of the triangle's hypotenuse | Yes |
-| `leg` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `leg` | [`number`](/docs/kcl/types/number) | The length of one of the triangle's legs (i.e. non-hypotenuse side) | Yes |
 
 ### Returns
 
@@ -34,8 +34,8 @@ legAngY(
 
 ### Examples
 
-```js
+```kcl
-legAngY(5, 3)
+legAngY(hypotenuse = 5, leg = 3)
 ```
 
 

docs/kcl/legLen.md

@@ -8,11 +8,11 @@ Compute the length of the given leg.
 
 
 
-```js
+```kcl
 legLen(
-  hypotenuse: number,
+  hypotenuse: [number](/docs/kcl/types/number),
-  leg: number,
+  leg: [number](/docs/kcl/types/number),
-): number
+): [number](/docs/kcl/types/number)
 ```
 
 ### Tags
@@ -24,8 +24,8 @@ legLen(
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `hypotenuse` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `hypotenuse` | [`number`](/docs/kcl/types/number) | The length of the triangle's hypotenuse | Yes |
-| `leg` | [`number`](/docs/kcl/types/number) |  | Yes |
+| `leg` | [`number`](/docs/kcl/types/number) | The length of one of the triangle's legs (i.e. non-hypotenuse side) | Yes |
 
 ### Returns
 
@@ -34,8 +34,8 @@ legLen(
 
 ### Examples
 
-```js
+```kcl
-legLen(5, 3)
+legLen(hypotenuse = 5, leg = 3)
 ```
 
 

docs/kcl/line.md

@@ -8,13 +8,13 @@ Extend the current sketch with a new straight line.
 
 
 
-```js
+```kcl
 line(
-  sketch: Sketch,
+  sketch: [Sketch](/docs/kcl/types/Sketch),
-  endAbsolute?: [number],
+  endAbsolute?: [[[number](/docs/kcl/types/number)]](/docs/kcl/types/[number](/docs/kcl/types/number)),
-  end?: [number],
+  end?: [[[number](/docs/kcl/types/number)]](/docs/kcl/types/[number](/docs/kcl/types/number)),
-  tag?: TagDeclarator,
+  tag?: [TagDeclarator](/docs/kcl/types#tag-declaration),
-): Sketch
+): [Sketch](/docs/kcl/types/Sketch)
 ```
 
 
@@ -25,7 +25,7 @@ line(
 | `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | Which sketch should this path be added to? | Yes |
 | `endAbsolute` | [`[number]`](/docs/kcl/types/number) | Which absolute point should this line go to? Incompatible with `end`. | No |
 | `end` | [`[number]`](/docs/kcl/types/number) | How far away (along the X and Y axes) should this line go? Incompatible with `endAbsolute`. | No |
-| [`tag`](/docs/kcl/types/tag) | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Create a new tag which refers to this line | No |
+| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Create a new tag which refers to this line | No |
 
 ### Returns
 
@@ -34,9 +34,9 @@ line(
 
 ### Examples
 
-```js
+```kcl
 triangle = startSketchOn(XZ)
-  |> startProfileAt([0, 0], %)
+  |> startProfile(at = [0, 0])
   // The END argument means it ends at exactly [10, 0].
   // This is an absolute measurement, it is NOT relative to
   // the start of the sketch.
@@ -47,7 +47,7 @@ triangle = startSketchOn(XZ)
   |> extrude(length = 5)
 
 box = startSketchOn(XZ)
-  |> startProfileAt([10, 10], %)
+  |> startProfile(at = [10, 10])
   // The 'to' argument means move the pen this much.
   // So, [10, 0] is a relative distance away from the current point.
   |> line(end = [10, 0])

docs/kcl/modules.md

@@ -10,7 +10,7 @@ isolated from other files as a separate module.
 When you define a function, you can use `export` before it to make it available
 to other modules.
 
-```
+```kcl
 // util.kcl
 export fn increment(x) {
   return x + 1
@@ -31,11 +31,11 @@ Imported files _must_ be in the same project so that units are uniform across
 modules. This means that it must be in the same directory.
 
 Import statements must be at the top-level of a file. It is not allowed to have
-an `import` statement inside a function or in the body of an if-else.
+an `import` statement inside a function or in the body of an if‑else.
 
 Multiple functions can be exported in a file.
 
-```
+```kcl
 // util.kcl
 export fn increment(x) {
   return x + 1
@@ -58,6 +58,215 @@ Imported symbols can be renamed for convenience or to avoid name collisions.
 import increment as inc, decrement as dec from "util.kcl"
 ```
 
+---
+
+## Functions vs `clone`
+
+There are two common patterns for re‑using geometry:
+
+1. **Wrap the construction in a function** – flexible and fully parametric.
+2. **Duplicate an existing object with `clone`** – lightning‑fast, but an exact
+   duplicate.
+
+### Parametric function example
+
+```kcl
+fn cube(center) {
+  return startSketchOn(XY)
+    |> startProfile(at = [center[0] - 10, center[1] - 10])
+    |> line(endAbsolute = [center[0] + 10, center[1] - 10])
+    |> line(endAbsolute = [center[0] + 10, center[1] + 10])
+    |> line(endAbsolute = [center[0] - 10, center[1] + 10])
+    |> close()
+    |> extrude(length = 10)
+}
+
+myCube = cube([0, 0])
+```
+
+*Pros*
+- Any argument can be a parameter – size, position, appearance, etc.
+- Works great inside loops, arrays, or optimisation sweeps.
+
+*Cons*
+- Every invocation rebuilds the entire feature tree.
+- **Slower** than a straight duplicate – each call is its own render job.
+
+### `clone` example
+
+```kcl
+sketch001 = startSketchOn(-XZ)
+  |> circle(center = [0, 0], radius = 10)
+  |> extrude(length = 5) 
+  |> appearance(color = "#ff0000", metalness = 90, roughness = 90)
+
+sketch002 = clone(sketch001)  // ✓ instant copy
+```
+
+*Pros*
+- Roughly an O(1) operation – we just duplicate the underlying engine handle.
+- Perfect when you need ten identical bolts or two copies of the same imported STEP file.
+
+*Cons*
+- **Not parametric** – the clone is exactly the same shape as the source.
+- If you need to tweak dimensions per‑instance, you’re back to a function.
+
+> **Rule of thumb** – Reach for `clone` when the geometry is already what you want. Reach for a function when you need customisation.
+
+---
+
+## Module‑level parallelism
+
+Under the hood, the Design Studio runs **every module in parallel** where it can. This means:
+
+- The top‑level code of `foo.kcl`, `bar.kcl`, and `baz.kcl` all start executing immediately and concurrently.
+- Imports that read foreign files (STEP/OBJ/…) overlap their I/O and background render.
+- CPU‑bound calculations in separate modules get their own worker threads.
+
+### Why modules beat one‑big‑file
+
+If you shoe‑horn everything into `main.kcl`, each statement runs sequentially:
+
+```norun
+import "big.step" as gizmo  // blocks main while reading
+
+gizmo |> translate(x=50)    // blocks again while waiting for render
+```
+
+Split `gizmo` into its own file and the read/render can overlap whatever else `main.kcl` is doing.
+
+```norun
+// gizmo.kcl                   (worker A)
+import "big.step"
+
+// main.kcl                    (worker B)
+import "gizmo.kcl" as gizmo   // non‑blocking
+
+// ... other setup ...
+
+gizmo |> translate(x=50)      // only blocks here
+```
+
+### Gotcha: defining but **not** calling functions
+
+Defining a function inside a module is instantaneous – we just record the byte‑code. The heavy lifting happens when the function is **called**. So:
+
+```norun
+// util.kcl
+export fn makeBolt(size) { /* … expensive CAD … */ }
+```
+
+If `main.kcl` waits until the very end to call `makeBolt`, *none* of that work was parallelised – you’ve pushed the cost back onto the serial tail of your script.
+
+**Better:** call it early or move the invocation into another module.
+
+```norun
+// bolt_instance.kcl
+import makeBolt from "util.kcl"
+bolt = makeBolt(5)  // executed in parallel
+bolt
+```
+
+Now `main.kcl` can `import "bolt_instance.kcl" as bolt` and get the result that was rendered while it was busy doing other things.
+
+---
+
+## Whole module import
+
+You can also import the whole module. This is useful if you want to use the
+result of a module as a variable, like a part.
+
+```norun
+import "tests/inputs/cube.kcl" as cube
+cube
+  |> translate(x=10)
+```
+
+This imports the whole module and makes it available as `cube`. You can then
+use it like any other object. The `cube` variable is now a reference to the
+result of the module. This means that if you change the module, the `cube`
+variable will change as well.
+
+In `cube.kcl`, you cannot have multiple objects. It has to be a single part. If
+you have multiple objects, you will get an error. This is because the module is
+expected to return a single object that can be used as a variable.
+
+The last expression or variable definition becomes the module's return value.
+The module is expected to return a single object that can be used as a variable
+by whatever imports it.
+
+So for example, this is allowed:
+
+```norun
+... a bunch of code to create cube and cube2 ...
+
+myUnion = union([cube, cube2])
+```
+
+You can also do this:
+
+```norun
+... a bunch of code to create cube and cube2 ...
+
+union([cube, cube2])
+```
+
+Either way, the last line will return the union of the two objects.
+
+Or what you could do instead is:
+
+```norun
+... a bunch of code to create cube and cube2 ...
+
+myUnion = union([cube, cube2])
+myUnion
+```
+
+This will assign the union of the two objects to a variable, and then return it
+on the last statement. It's simply another way of doing the same thing.
+
+The final statement is what's important because it's the return value of the
+entire module. The module is expected to return a single object that can be used
+as a variable by the file that imports it.
+
+---
+
+## Multiple instances of the same import
+
+Whether you are importing a file from another CAD system or a KCL file, that
+file represents object(s) in memory. If you import the same file multiple times,
+it will only be rendered once.
+
+If you want to have multiple instances of the same object, you can use the
+[`clone`](/docs/kcl/clone) function. This will render a new instance of the object in memory.
+
+```norun
+import cube from "tests/inputs/cube.kcl"
+
+cube  
+  |> translate(x=10)
+clone(cube)
+  |> translate(x=20)
+```
+
+In the sample above, the `cube` object is imported from a KCL file. The first
+instance is translated 10 units in the x direction. The second instance is
+cloned and translated 20 units in the x direction. The two instances are now
+separate objects in memory, and can be manipulated independently.
+
+Here is an example with a file from another CAD system:
+
+```kcl
+import "tests/inputs/cube.step" as cube
+
+cube
+  |> translate(x=10)
+clone(cube)
+  |> translate(x=20)
+```
+
+---
+
 ## Importing files from other CAD systems
 
 `import` can also be used to import files from other CAD systems. The format of the statement is the
@@ -69,26 +278,18 @@ import "tests/inputs/cube.obj"
 // Use `cube` just like a KCL object.
 ```
 
-```norun
+```kcl
-import "tests/inputs/cube-2.sldprt" as cube
+import "tests/inputs/cube.sldprt" as cube
 
 // Use `cube` just like a KCL object.
 ```
 
-You can make the file format explicit using a format attribute (useful if using a different
-extension), e.g.,
-
-```norun
-@(format = obj)
-import "tests/inputs/cube"
-```
-
 For formats lacking unit data (such as STL, OBJ, or PLY files), the default
 unit of measurement is millimeters. Alternatively you may specify the unit
-by using an attirbute. Likewise, you can also specify a coordinate system. E.g.,
+by using an attribute. Likewise, you can also specify a coordinate system. E.g.,
 
-```norun
+```kcl
-@(unitLength = ft, coords = opengl)
+@(lengthUnit = ft, coords = opengl)
 import "tests/inputs/cube.obj"
 ```
 
@@ -109,3 +310,56 @@ Coordinate systems:
 - `zoo` (the default), forward: -Y, up: +Z, handedness: right
 - `opengl`, forward: +Z, up: +Y, handedness: right
 - `vulkan`, forward: +Z, up: -Y, handedness: left
+
+---
+
+## Performance deep‑dive for foreign‑file imports
+
+Parallelized foreign‑file imports now let you overlap file reads, initialization,
+and rendering. To maximize throughput, you need to understand the three distinct
+stages—reading, initializing (background render start), and invocation (blocking)
+—and structure your code to defer blocking operations until the end.
+
+### Foreign import execution stages
+
+1. **Import (Read / Initialization) Stage**
+   ```kcl
+   import "tests/inputs/cube.step" as cube
+   ```
+   - Reads the file from disk and makes its API available.
+   - Starts engine rendering but **does not block** your script.
+   - This kick‑starts the render pipeline while you keep executing other code.
+
+2. **Invocation (Blocking) Stage**
+   ```kcl
+   import "tests/inputs/cube.step" as cube
+
+   cube
+     |> translate(z=10) // ← blocks here only
+   ```
+   - Any method call (e.g., `translate`, `scale`, `rotate`) waits for the background render to finish before applying transformations.
+
+### Best practices
+
+#### 1. Defer blocking calls
+
+```kcl
+import "tests/inputs/cube.step" as cube     // 1) Read / Background render starts
+
+
+// --- perform other operations and calculations here ---
+
+
+cube
+  |> translate(z=10)                        // 2) Blocks only here
+```
+
+#### 2. Split heavy work into separate modules
+
+Place computationally expensive or IO‑heavy work into its own module so it can render in parallel while `main.kcl` continues.
+
+#### Future improvements
+
+Upcoming releases will auto‑analyse dependencies and only block when truly necessary. Until then, explicit deferral will give you the best performance.
+
+

docs/kcl/patternCircular2d.md

@@ -8,15 +8,15 @@ Repeat a 2-dimensional sketch some number of times along a partial or complete c
 
 
 
-```js
+```kcl
 patternCircular2d(
-  sketchSet: [Sketch],
+  sketchSet: [[[Sketch](/docs/kcl/types/Sketch)]](/docs/kcl/types/[Sketch](/docs/kcl/types/Sketch)),
   instances: integer,
-  center: [number],
+  center: [[[number](/docs/kcl/types/number)]](/docs/kcl/types/[number](/docs/kcl/types/number)),
-  arcDegrees: number,
+  arcDegrees: [number](/docs/kcl/types/number),
-  rotateDuplicates: bool,
+  rotateDuplicates: [bool](/docs/kcl/types/bool),
-  useOriginal?: bool,
+  useOriginal?: [bool](/docs/kcl/types/bool),
-): [Sketch]
+): [[[Sketch](/docs/kcl/types/Sketch)]](/docs/kcl/types/[Sketch](/docs/kcl/types/Sketch))
 ```
 
 
@@ -38,9 +38,9 @@ patternCircular2d(
 
 ### Examples
 
-```js
+```kcl
 exampleSketch = startSketchOn(XZ)
-  |> startProfileAt([.5, 25], %)
+  |> startProfile(at = [.5, 25])
   |> line(end = [0, 5])
   |> line(end = [-1, 0])
   |> line(end = [0, -5])

docs/kcl/patternCircular3d.md

@@ -8,16 +8,16 @@ Repeat a 3-dimensional solid some number of times along a partial or complete ci
 
 
 
-```js
+```kcl
 patternCircular3d(
-  solids: [Solid],
+  solids: [[[Solid](/docs/kcl/types/Solid)]](/docs/kcl/types/[Solid](/docs/kcl/types/Solid)),
   instances: integer,
-  axis: [number],
+  axis: [[[number](/docs/kcl/types/number)]](/docs/kcl/types/[number](/docs/kcl/types/number)),
-  center: [number],
+  center: [[[number](/docs/kcl/types/number)]](/docs/kcl/types/[number](/docs/kcl/types/number)),
-  arcDegrees: number,
+  arcDegrees: [number](/docs/kcl/types/number),
-  rotateDuplicates: bool,
+  rotateDuplicates: [bool](/docs/kcl/types/bool),
-  useOriginal?: bool,
+  useOriginal?: [bool](/docs/kcl/types/bool),
-): [Solid]
+): [[[Solid](/docs/kcl/types/Solid)]](/docs/kcl/types/[Solid](/docs/kcl/types/Solid))
 ```
 
 
@@ -40,7 +40,7 @@ patternCircular3d(
 
 ### Examples
 
-```js
+```kcl
 exampleSketch = startSketchOn(XZ)
   |> circle(center = [0, 0], radius = 1)
 

docs/kcl/patternLinear2d.md

@@ -8,14 +8,14 @@ Repeat a 2-dimensional sketch along some dimension, with a dynamic amount of dis
 
 
 
-```js
+```kcl
 patternLinear2d(
-  sketches: [Sketch],
+  sketches: [[[Sketch](/docs/kcl/types/Sketch)]](/docs/kcl/types/[Sketch](/docs/kcl/types/Sketch)),
   instances: integer,
-  distance: number,
+  distance: [number](/docs/kcl/types/number),
-  axis: [number],
+  axis: [[[number](/docs/kcl/types/number)]](/docs/kcl/types/[number](/docs/kcl/types/number)),
-  useOriginal?: bool,
+  useOriginal?: [bool](/docs/kcl/types/bool),
-): [Sketch]
+): [[[Sketch](/docs/kcl/types/Sketch)]](/docs/kcl/types/[Sketch](/docs/kcl/types/Sketch))
 ```
 
 
@@ -36,7 +36,7 @@ patternLinear2d(
 
 ### Examples
 
-```js
+```kcl
 exampleSketch = startSketchOn(XZ)
   |> circle(center = [0, 0], radius = 1)
   |> patternLinear2d(axis = [1, 0], instances = 7, distance = 4)

docs/kcl/patternTransform2d.md

@@ -8,13 +8,13 @@ Just like patternTransform, but works on 2D sketches not 3D solids.
 
 
 
-```js
+```kcl
 patternTransform2d(
-  sketches: [Sketch],
+  sketches: [[[Sketch](/docs/kcl/types/Sketch)]](/docs/kcl/types/[Sketch](/docs/kcl/types/Sketch)),
   instances: integer,
   transform: FunctionSource,
-  useOriginal?: bool,
+  useOriginal?: [bool](/docs/kcl/types/bool),
-): [Sketch]
+): [[[Sketch](/docs/kcl/types/Sketch)]](/docs/kcl/types/[Sketch](/docs/kcl/types/Sketch))
 ```
 
 
@@ -34,7 +34,7 @@ patternTransform2d(
 
 ### Examples
 
-```js
+```kcl
 // Each instance will be shifted along the X axis.
 fn transform(id) {
   return { translate = [4 * id, 0] }

docs/kcl/profileStart.md

@@ -8,8 +8,8 @@ Extract the provided 2-dimensional sketch's profile's origin value.
 
 
 
-```js
+```kcl
-profileStart(sketch: Sketch): [number]
+profileStart(profile: [Sketch](/docs/kcl/types/Sketch)): [[[number](/docs/kcl/types/number)]](/docs/kcl/types/[number](/docs/kcl/types/number))
 ```
 
 
@@ -17,7 +17,7 @@ profileStart(sketch: Sketch): [number]
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) |  | Yes |
+| `profile` | [`Sketch`](/docs/kcl/types/Sketch) | Profile whose start is being used | Yes |
 
 ### Returns
 
@@ -26,9 +26,9 @@ profileStart(sketch: Sketch): [number]
 
 ### Examples
 
-```js
+```kcl
 sketch001 = startSketchOn(XY)
-  |> startProfileAt([5, 2], %)
+  |> startProfile(at = [5, 2])
   |> angledLine(angle = 120, length = 50, tag = $seg01)
   |> angledLine(angle = segAng(seg01) + 120, length = 50)
   |> line(end = profileStart(%))

docs/kcl/profileStartX.md

@@ -8,8 +8,8 @@ Extract the provided 2-dimensional sketch's profile's origin's 'x' value.
 
 
 
-```js
+```kcl
-profileStartX(sketch: Sketch): number
+profileStartX(profile: [Sketch](/docs/kcl/types/Sketch)): [number](/docs/kcl/types/number)
 ```
 
 
@@ -17,7 +17,7 @@ profileStartX(sketch: Sketch): number
 
 | Name | Type | Description | Required |
 |----------|------|-------------|----------|
-| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) |  | Yes |
+| `profile` | [`Sketch`](/docs/kcl/types/Sketch) | Profile whose start is being used | Yes |
 
 ### Returns
 
@@ -26,9 +26,9 @@ profileStartX(sketch: Sketch): number
 
 ### Examples
 
-```js
+```kcl
 sketch001 = startSketchOn(XY)
-  |> startProfileAt([5, 2], %)
+  |> startProfile(at = [5, 2])
   |> angledLine(angle = -26.6, length = 50)
   |> angledLine(angle = 90, length = 50)
   |> angledLine(angle = 30, endAbsoluteX = profileStartX(%))