Release KCL 82 (#7531)

* Resurrect this branch with an initial commit

* Add telemetry to global default items

* Add credit progress bar to status bar

* Add selection info to status bar

* Add help menu to "local" side

* Rename statusBarItem utils

* Delete LowerRightControls, now unused

* fix lints

* Update snapshots

* Add test-id to network health indicator, which all E2E tests rely on

* Update src/components/StatusBar/StatusBar.tsx

Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com>

* Fix a couple little issues with the e2e tests

* Fix gizmo e2e tests (it moved) and network health test (it should not be on home page)

* More tweaks to accomodate changes to network health indicator

We made use of two test ID's to make Playwright aware of the state, one
of which was on the icon. Now that we want to normalize usage of the
status bar along a more limited API, that became a not possible. This
just tweaks some test code that relied on that fact.

* Fix lints

* Update snapshots

* Re-run CI

* Update snapshots

* Update snapshots

* Test fixes, label logic tweaks

* Update snapshots

* Update snapshots

* Fix up last few tests hopefully. Relative path syntax failed on windows

* Relative paths are behaving badly on Windows, use the old code here

* Update snapshots

* Update snapshots

* Tweak y-value to work on all platforms, ubuntu didn't like 438

* Fix tooltip and popover alignment on NetworkMachineIndicator

* Remove dire warning comment

* Update src/components/StatusBar/defaultStatusBarItems.tsx

Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com>

* @lee-at-zoo-corp feedback, pull hooks out of UI code

* Re-run CI

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com>

.github/CODEOWNERS

@@ -0,0 +1,3 @@
+* @KittyCAD/frontend
+/src/ @KittyCAD/frontend
+/rust/ @KittyCAD/kcl

.github/ISSUE_TEMPLATE/release.md

@@ -0,0 +1,38 @@
+---
+name: Release
+about: Create a new release for the Zoo Design Studio
+title: "Cut release v1.?.?"
+labels: [release]
+---
+
+> Instructions: https://github.com/KittyCAD/modeling-app/blob/main/CONTRIBUTING.md#shipping-releases
+
+---
+
+# Manual Checklist
+
+Release builds URL: ???
+
+## Windows via ???
+
+* [ ] Download the release build for this platform
+* [ ] Confirm the application opens (dismiss the updater)
+* [ ] Create a project with a basic Text-to-CAD prompt
+* [ ] Confirm the result is viewable in an engine stream
+* [ ] Open the application again and confirm the updater can downgrade
+
+## macOS via ???
+
+* [ ] Download the release build for this platform
+* [ ] Confirm the application opens (dismiss the updater)
+* [ ] Create a project with a basic Text-to-CAD prompt
+* [ ] Confirm the result is viewable in an engine stream
+* [ ] Open the application again and confirm the updater can downgrade
+
+## Linux via ???
+
+* [ ] Download the release build for this platform
+* [ ] Confirm the application opens (dismiss the updater)
+* [ ] Create a project with a basic Text-to-CAD prompt
+* [ ] Confirm the result is viewable in an engine stream
+* [ ] Open the application again and confirm the updater can downgrade

.github/workflows/build-apps.yml

@@ -10,7 +10,7 @@ on:
 
 env:
   IS_RELEASE: ${{ github.ref_type == 'tag' && startsWith(github.ref_name, 'v') }}
-  IS_NIGHTLY: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+  IS_STAGING: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -91,14 +91,14 @@ jobs:
         if: ${{ steps.wasm.outputs.should-build-wasm == 'true' }}
         run: "npm run build:wasm"
 
-      - name: Set nightly version, product name, release notes, and icons
-        if: ${{ env.IS_NIGHTLY == 'true' }}
+      - name: Set staging version, product name, release notes, and icons
+        if: ${{ env.IS_STAGING == 'true' }}
         run: |
           COMMIT=$(git rev-parse --short HEAD)
           DATE=$(date +'%-y.%-m.%-d')
           export VERSION=$DATE-main.$COMMIT
           npm run files:set-version
-          npm run files:flip-to-nightly
+          npm run files:flip-to-staging
 
       - name: Set release version
         if: ${{ env.IS_RELEASE == 'true' }}
@@ -130,13 +130,14 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - os: macos-14
-            platform: mac
-          - os: windows-2022
-            platform: win
+          - os: namespace-profile-macos-6-cores
+            platform: macos
+          - os: namespace-profile-windows-4-cores
+            platform: windows
           - os: ubuntu-22.04
             platform: linux
     runs-on: ${{ matrix.os }}
+    name: build-apps (${{ matrix.platform }})
     env:
       VERSION_NO_V: ${{ needs.prepare-files.outputs.version }}
     steps:
@@ -166,14 +167,14 @@ jobs:
       - run: npm install
 
       - name: Prepare certificate and variables (Windows only)
-        if: ${{ (env.IS_RELEASE == 'true' || env.IS_NIGHTLY == 'true') && matrix.os == 'windows-2022' }}
+        if: ${{ (env.IS_RELEASE == 'true' || env.IS_STAGING == 'true') && matrix.platform == 'windows' }}
         run: |
-          echo "${{secrets.SM_CLIENT_CERT_FILE_B64 }}" | base64 --decode > /d/Certificate_pkcs12.p12
-          cat /d/Certificate_pkcs12.p12
+          echo "${{secrets.SM_CLIENT_CERT_FILE_B64 }}" | base64 --decode > /c/Certificate_pkcs12.p12
+          cat /c/Certificate_pkcs12.p12
           echo "::set-output name=version::${GITHUB_REF#refs/tags/v}"
           echo "SM_HOST=${{ secrets.SM_HOST }}" >> "$GITHUB_ENV"
           echo "SM_API_KEY=${{ secrets.SM_API_KEY }}" >> "$GITHUB_ENV"
-          echo "SM_CLIENT_CERT_FILE=D:\\Certificate_pkcs12.p12" >> "$GITHUB_ENV"
+          echo "SM_CLIENT_CERT_FILE=C:\\Certificate_pkcs12.p12" >> "$GITHUB_ENV"
           echo "SM_CLIENT_CERT_PASSWORD=${{ secrets.SM_CLIENT_CERT_PASSWORD }}" >> "$GITHUB_ENV"
           echo "C:\Program Files (x86)\Windows Kits\10\App Certification Kit" >> $GITHUB_PATH
           echo "C:\Program Files (x86)\Microsoft SDKs\Windows\v10.0A\bin\NETFX 4.8 Tools" >> $GITHUB_PATH
@@ -181,7 +182,7 @@ jobs:
         shell: bash
 
       - name: Setup certicate with SSM KSP (Windows only)
-        if: ${{ (env.IS_RELEASE == 'true' || env.IS_NIGHTLY == 'true') && matrix.os == 'windows-2022' }}
+        if: ${{ (env.IS_RELEASE == 'true' || env.IS_STAGING == 'true') && matrix.platform == 'windows' }}
         run: |
           curl -X GET  https://one.digicert.com/signingmanager/api-ui/v1/releases/smtools-windows-x64.msi/download -H "x-api-key:%SM_API_KEY%" -o smtools-windows-x64.msi
           msiexec /i smtools-windows-x64.msi /quiet /qn
@@ -191,7 +192,7 @@ jobs:
           smksp_cert_sync.exe
           smctl windows certsync
         # This last line `smctl windows certsync` was added after windows codesign failures started happening
-        # with nightly-v25.4.10. It looks like `smksp_cert_sync.exe` used to do the sync to the local cert store,
+        # with staging-v25.4.10. It looks like `smksp_cert_sync.exe` used to do the sync to the local cert store,
         # but stopped doing it overnight. This extra call that I randomly got from this azure-related doc page
         # https://docs.digicert.com/en/digicert-keylocker/code-signing/sign-with-third-party-signing-tools/windows-applications/sign-azure-apps-with-signtool-using-ksp-library.html#sync-certificates--windows-only--618365
         # seems to be doing that extra sync that we need for scripts/sign-win.js to work.
@@ -199,13 +200,13 @@ jobs:
         shell: cmd
 
       - name: Build the app (debug)
-        if: ${{ env.IS_RELEASE == 'false' && env.IS_NIGHTLY == 'false' }}
+        if: ${{ env.IS_RELEASE == 'false' && env.IS_STAGING == 'false' }}
         # electron-builder doesn't have a concept of release vs debug,
         # this is just not doing any codesign or release yml generation, and points to dev infra
         run: npm run tronb:package:dev
 
       - name: Build the app (release)
-        if: ${{ env.IS_RELEASE == 'true' || env.IS_NIGHTLY == 'true' }}
+        if: ${{ env.IS_RELEASE == 'true' || env.IS_STAGING == 'true' }}
         env:
           APPLE_ID: ${{ secrets.APPLE_ID }}
           APPLE_PASSWORD: ${{ secrets.APPLE_PASSWORD }}
@@ -215,7 +216,7 @@ jobs:
           CSC_KEY_PASSWORD: ${{ secrets.APPLE_CERTIFICATE_PASSWORD }}
           CSC_KEYCHAIN: ${{ secrets.APPLE_SIGNING_IDENTITY }}
           WINDOWS_CERTIFICATE_THUMBPRINT: ${{ secrets.WINDOWS_CERTIFICATE_THUMBPRINT }}
-        run: npm run tronb:package:prod
+        run: npm run tronb:package:${{ env.IS_STAGING == 'true' && 'dev' || 'prod' }}
 
       - name: List artifacts in out/
         run: ls -R out
@@ -239,20 +240,20 @@ jobs:
             out/*-x86_64-linux.*
 
       - uses: actions/upload-artifact@v4
-        if: ${{ env.IS_RELEASE == 'true' || env.IS_NIGHTLY == 'true' }}
+        if: ${{ env.IS_RELEASE == 'true' || env.IS_STAGING == 'true' }}
         with:
           name: out-yml-${{ matrix.platform }}
           path: |
             out/latest*.yml
 
-      # TODO: add the 'Build for Mac TestFlight (nightly)' stage back
+      # TODO: add the 'Build for Mac TestFlight' stage back
 
 
   upload-apps-release:
     runs-on: ubuntu-22.04
     permissions:
       contents: write
-    # Equivalent to IS_RELEASE || IS_NIGHTLY (but we can't access those env vars here)
+    # Equivalent to IS_RELEASE || IS_STAGING (but we can't access those env vars here)
     if: ${{ (github.ref_type == 'tag' && startsWith(github.ref_name, 'v')) || (github.event_name == 'push' && github.ref == 'refs/heads/main') }}
     env:
       VERSION_NO_V: ${{ needs.prepare-files.outputs.version }}
@@ -263,32 +264,32 @@ jobs:
 
       - uses: actions/download-artifact@v4
         with:
-          name: out-arm64-win
+          name: out-arm64-windows
           path: out
 
       - uses: actions/download-artifact@v4
         with:
-          name: out-x64-win
+          name: out-x64-windows
           path: out
 
       - uses: actions/download-artifact@v4
         with:
-          name: out-yml-win
+          name: out-yml-windows
           path: out
 
       - uses: actions/download-artifact@v4
         with:
-          name: out-arm64-mac
+          name: out-arm64-macos
           path: out
 
       - uses: actions/download-artifact@v4
         with:
-          name: out-x64-mac
+          name: out-x64-macos
           path: out
 
       - uses: actions/download-artifact@v4
         with:
-          name: out-yml-mac
+          name: out-yml-macos
           path: out
 
       - uses: actions/download-artifact@v4
@@ -310,8 +311,8 @@ jobs:
         env:
           NOTES: ${{ needs.prepare-files.outputs.notes }}
           PUB_DATE: ${{ github.event.repository.updated_at }}
-          WEBSITE_DIR: ${{ env.IS_NIGHTLY == 'true' && 'dl.zoo.dev/releases/modeling-app/nightly' || 'dl.zoo.dev/releases/modeling-app' }}
-          URL_CODED_NAME: ${{ env.IS_NIGHTLY == 'true' && 'Zoo%20Design%20Studio%20%28Nightly%29' || 'Zoo%20Design%20Studio' }}
+          WEBSITE_DIR: ${{ env.IS_STAGING == 'true' && 'dl.zoo.dev/releases/modeling-app/staging' || 'dl.zoo.dev/releases/modeling-app' }}
+          URL_CODED_NAME: ${{ env.IS_STAGING == 'true' && 'Zoo%20Design%20Studio%20%28Staging%29' || 'Zoo%20Design%20Studio' }}
         run: |
           RELEASE_DIR=https://${WEBSITE_DIR}
           jq --null-input \
@@ -360,26 +361,26 @@ jobs:
         run: "ls -R out"
 
       - name: Authenticate to Google Cloud
-        if: ${{ env.IS_NIGHTLY == 'true' }}
+        if: ${{ env.IS_STAGING == 'true' }}
         uses: 'google-github-actions/auth@v2.1.8'
         with:
           credentials_json: '${{ secrets.GOOGLE_CLOUD_DL_SA }}'
 
       - name: Set up Google Cloud SDK
-        if: ${{ env.IS_NIGHTLY == 'true' }}
+        if: ${{ env.IS_STAGING == 'true' }}
         uses: google-github-actions/setup-gcloud@v2.1.4
         with:
           project_id: ${{ env.GOOGLE_CLOUD_PROJECT_ID }}
 
-      - name: Upload nightly files to public bucket
-        if: ${{ env.IS_NIGHTLY == 'true' }}
+      - name: Upload staging files to public bucket
+        if: ${{ env.IS_STAGING == 'true' }}
         uses: google-github-actions/upload-cloud-storage@v2.2.2
         with:
           path: out
           glob: '*'
           parent: false
-          destination: 'dl.kittycad.io/releases/modeling-app/nightly'
+          destination: 'dl.kittycad.io/releases/modeling-app/staging'
 
       - name: Invalidate bucket cache on latest*.yml and last_download.json files
-        if: ${{ env.IS_NIGHTLY == 'true' }}
-        run: npm run files:invalidate-bucket:nightly
+        if: ${{ env.IS_STAGING == 'true' }}
+        run: npm run files:invalidate-bucket:staging

.github/workflows/cargo-fmt.yml

@@ -31,15 +31,15 @@ jobs:
       - name: Use correct Rust toolchain
         shell: bash
         run: |
-          [ -e rust-toolchain.toml ] || cp rust/rust-toolchain.toml ./
+          cp .github/workflows/nightly-rust-toolchain.toml rust-toolchain.toml
       - name: Install rust
         uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
           cache-workspaces: rust
           components: rustfmt
 
-      - name: Run cargo fmt
+      - name: Run nightly cargo fmt
         run: |
           cd rust
-          cargo fmt -- --check
+          cargo +nightly fmt -- --check
         shell: bash

.github/workflows/e2e-tests.yml

@@ -95,7 +95,8 @@ jobs:
         shell: bash
         run: npm run build:wasm
 
-      - uses: actions/upload-artifact@v4
+      - name: Upload compiled wasm artifacts
+        uses: actions/upload-artifact@v4
         with:
           name: prepared-wasm
           path: |
@@ -176,17 +177,18 @@ jobs:
           CI_SUITE: e2e:snapshots
           TARGET: web
 
-      - uses: actions/upload-artifact@v4
-        if: ${{ !cancelled() && (success() || failure()) }}
+      - name: Upload playwright report
+        uses: actions/upload-artifact@v4
+        if: ${{ !cancelled() }}
         with:
-          name: playwright-report-ubuntu-snapshot-${{ github.sha }}
+          name: playwright-report-snapshot-${{ github.sha }}
           path: playwright-report/
           include-hidden-files: true
           retention-days: 30
           overwrite: true
 
       - name: Check diff
-        if: ${{ github.ref != 'refs/heads/main' }}
+        if: ${{ always() && github.ref != 'refs/heads/main' }}
         shell: bash
         id: git-check
         run: |
@@ -197,7 +199,7 @@ jobs:
             fi
 
       - name: Commit changes
-        if: ${{ steps.git-check.outputs.modified == 'true' }}
+        if: ${{ always() && steps.git-check.outputs.modified == 'true' }}
         shell: bash
         run: |
           git add e2e/playwright/snapshot-tests.spec.ts-snapshots e2e/playwright/snapshots
@@ -220,7 +222,7 @@ jobs:
         include:
           - os: "runs-on=${{ github.run_id }}/family=i7ie.2xlarge/image=ubuntu22-full-x64"
           - os: namespace-profile-macos-8-cores
-          - os: windows-latest-8-cores
+          - os: namespace-profile-windows-8-cores
     runs-on: ${{ matrix.os }}
     name: e2e:web (${{ contains(matrix.os, 'ubuntu') && 'ubuntu' || (contains(matrix.os, 'windows') && 'windows' || 'macos') }})
     env:
@@ -290,9 +292,11 @@ jobs:
           CI_SUITE: e2e:web
           TARGET: web
 
-      - uses: actions/upload-artifact@v4
+      - name: Upload playwright report
+        uses: actions/upload-artifact@v4
         if: ${{ !cancelled() && (success() || failure()) }}
         with:
+          name: playwright-report-web-${{ env.OS_NAME }}-${{ matrix.shardIndex }}-${{ github.sha }}
           path: playwright-report/
           include-hidden-files: true
           retention-days: 30
@@ -304,7 +308,6 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        # TODO: enable namespace-profile-windows-latest once available
         include:
           - os: "runs-on=${{ github.run_id }}/family=i7ie.2xlarge/image=ubuntu22-full-x64"
             shardIndex: 1
@@ -336,10 +339,10 @@ jobs:
           - os: namespace-profile-macos-8-cores
             shardIndex: 2
             shardTotal: 2
-          - os: windows-latest-8-cores
+          - os: namespace-profile-windows-8-cores
             shardIndex: 1
             shardTotal: 2
-          - os: windows-latest-8-cores
+          - os: namespace-profile-windows-8-cores
             shardIndex: 2
             shardTotal: 2
     runs-on: ${{ matrix.os }}
@@ -415,19 +418,21 @@ jobs:
           CI_SUITE: e2e:desktop
           TARGET: desktop
 
-      - uses: actions/upload-artifact@v4
+      - name: Upload test report
+        uses: actions/upload-artifact@v4
         if: always()
         with:
-          name: test-results-${{ env.OS_NAME }}-${{ matrix.shardIndex }}-${{ github.sha }}
+          name: test-results-desktop-${{ env.OS_NAME }}-${{ matrix.shardIndex }}-${{ github.sha }}
           path: test-results/
           include-hidden-files: true
           retention-days: 30
           overwrite: true
 
-      - uses: actions/upload-artifact@v4
+      - name: Upload playwright report
+        uses: actions/upload-artifact@v4
         if: always()
         with:
-          name: playwright-report-${{ env.OS_NAME }}-${{ matrix.shardIndex }}-${{ github.sha }}
+          name: playwright-report-desktop-${{ env.OS_NAME }}-${{ matrix.shardIndex }}-${{ github.sha }}
           path: playwright-report/
           include-hidden-files: true
           retention-days: 30

.github/workflows/nightly-rust-toolchain.toml

@@ -0,0 +1,3 @@
+[toolchain]
+channel = "nightly"
+components = ["rustfmt"]

.github/workflows/publish-apps-release.yml

@@ -31,42 +31,42 @@ jobs:
 
       - uses: actions/download-artifact@v4
         with:
-          name: out-arm64-win
+          name: out-arm64-windows
           path: out
           run-id: ${{ steps.tag_workflow_id.outputs.id }}
           github-token: ${{ secrets.GITHUB_TOKEN }}
           
       - uses: actions/download-artifact@v4
         with:
-          name: out-x64-win
+          name: out-x64-windows
           path: out
           run-id: ${{ steps.tag_workflow_id.outputs.id }}
           github-token: ${{ secrets.GITHUB_TOKEN }}
 
       - uses: actions/download-artifact@v4
         with:
-          name: out-yml-win
+          name: out-yml-windows
           path: out
           run-id: ${{ steps.tag_workflow_id.outputs.id }}
           github-token: ${{ secrets.GITHUB_TOKEN }}
 
       - uses: actions/download-artifact@v4
         with:
-          name: out-arm64-mac
+          name: out-arm64-macos
           path: out
           run-id: ${{ steps.tag_workflow_id.outputs.id }}
           github-token: ${{ secrets.GITHUB_TOKEN }}
 
       - uses: actions/download-artifact@v4
         with:
-          name: out-x64-mac
+          name: out-x64-macos
           path: out
           run-id: ${{ steps.tag_workflow_id.outputs.id }}
           github-token: ${{ secrets.GITHUB_TOKEN }}
 
       - uses: actions/download-artifact@v4
         with:
-          name: out-yml-mac
+          name: out-yml-macos
           path: out
           run-id: ${{ steps.tag_workflow_id.outputs.id }}
           github-token: ${{ secrets.GITHUB_TOKEN }}

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributor Guide
 
-## Running a development build
+## Installing dependencies
 
 Install a node version manager such as [fnm](https://github.com/Schniz/fnm?tab=readme-ov-#installation).
 
@@ -31,7 +31,9 @@ npm run install:rust:windows
 npm run install:wasm-pack:cargo
 ```
 
-Then to build the WASM layer, run:
+## Building the app
+
+To build the WASM layer, run:
 
 ```
 # macOS/Linux
@@ -74,7 +76,7 @@ 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
+### Developing with Electron
 
 To spin up the desktop app, `npm install` and `npm run build:wasm` need to have been done before hand then:
 
@@ -88,114 +90,7 @@ Devtools can be opened with the usual Command-Option-I (macOS) or Ctrl-Shift-I (
 
 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
-```
-
-## 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
-
-Decide on a `v`-prefixed semver `VERSION` (e.g. `v1.2.3`) with the team and tag the repo on the latest main:
-
-```
-git tag $VERSION --message=""
-git push origin $VERSION
-```
-
-This will trigger the `build-apps` workflow to set the version, build & sign the apps, and generate release files.
-
-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 step 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.
-
-A prompt should show up asking for a downgrade to the last release version. Running through that at the end of testing
-and making sure the current release candidate has the ability to be updated to what electron-updater points to is critical,
-but what is actually being downloaded and installed isn't.
-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.
-
-```
-# 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. Bump the KCL version
-
-Follow the instructions [here](./rust/README.md) to publish new crates.
-This ensures that the KCL accepted by the app is also accepted by the CLI.
-
-#### 5. 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.
-
-Click **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 click **Publish release**.
-
-A new `publish-apps-release` workflow will start 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.
-
-#### 6. 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
+## Running tests
 
 ### Playwright tests
 
@@ -313,8 +208,86 @@ then run tests that target the KCL language:
 npm run test:rust
 ```
 
+### 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).
+
 ### 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`.
+
+## Proposing changes
+
+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`
+
+## Shipping releases
+
+#### 1. Create a 'Cut release $VERSION' issue
+
+Use the **Release** issue template.
+This will be used to facilitate changelog discussions and release testing.
+
+https://github.com/KittyCAD/modeling-app/issues/new
+
+#### 2. Push a new tag
+
+Decide on a `v`-prefixed semver `VERSION` (e.g. `v1.2.3`) with the team and tag the repo on the latest main:
+
+```
+git tag $VERSION --message=""
+git push origin $VERSION
+```
+
+This will trigger the `build-apps` workflow to set the version, build & sign the apps, and generate release files.
+
+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
+
+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 step 2).
+
+Assign someone to each section of the manual checklist generated by the issue template.
+
+#### 4. Bump the KCL version
+
+Follow the instructions [here](./rust/README.md) to publish new crates.
+This ensures that the KCL accepted by the app is also accepted by the CLI.
+
+#### 5. 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.
+
+Click **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 click **Publish release**.
+
+A new `publish-apps-release` workflow will start 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.
+
+#### 6. Close the issue
+
+If everything is well and the release is out to the public, the issue tracking the release shall be closed.

docs/kcl-lang/numeric.md

@@ -46,3 +46,7 @@ KCL has no support for area, volume, or other higher dimension units. When inter
 ## Explicit conversions
 
 You might sometimes need to convert from one unit to another for some calculation. You can do this implicitly when calling a function (see above), but if you can't or don't want to, then you can use the explicit conversion functions in the [`std::units`](/docs/kcl-std/modules/std-units) module.
+
+KCL cannot know about changes to units caused by arithmetic. For example, you may intend for `10in * 25.4` to be the value `254mm` (i.e., `10in` in mm), however, the result of that computation in KCL is `254in`. It is always better to rely on automatic conversion or to use the explicit conversion functions, where possible.
+
+Converting between degrees and radians using π ([`PI`](/docs/kcl-std/consts/std-math-PI) in KCL) is especially prone to this error and so the `PI` constant always requires specifying units of any computation it is used with. E.g., `radius = (circumference / (2 * PI)): number(mm)`.

docs/kcl-lang/settings/project.md

@@ -4,8 +4,6 @@ excerpt: "Project specific settings for the app. These live in `project.toml` in
 layout: manual
 ---
 
-# Project Settings
-
 Project specific settings for the app. These live in `project.toml` in the base of the project directory. Updating the settings for the project in the app will update this file automatically. Do not edit this file manually, as it may be overwritten by the app. Manual edits can cause corruption of the settings file.
 
 ## Project Configuration Structure

docs/kcl-lang/settings/user.md

@@ -4,8 +4,6 @@ excerpt: "User specific settings for the app. These live in `user.toml` in the a
 layout: manual
 ---
 
-# User Settings
-
 User specific settings for the app. These live in `user.toml` in the app's configuration directory. Updating the settings in the app will update this file automatically. Do not edit this file manually, as it may be overwritten by the app. Manual edits can cause corruption of the settings file.
 
 ## User Configuration Structure

docs/kcl-lang/types.md

@@ -44,7 +44,7 @@ detail on importing geometry.
 
 Tags are used to give a name (tag) to a specific path.
 
-### `TagDeclarator`
+### Tag declarations - `TagDecl`
 
 The syntax for declaring a tag is `$myTag` you would use it in the following
 way:
@@ -67,24 +67,28 @@ startSketchOn(XZ)
   |> close()
 ```
 
-### `TagIdentifier`
+When a function requires declaring a new tag (using the `$` syntax), the argument has type [`TagDecl`](/docs/kcl-std/types/std-types-TagDecl).
 
-As per the example above you can use the tag identifier to get a reference to the 
-tagged object. The syntax for this is `myTag`.
+### Tag identifiers
 
-In the example above we use the tag identifier to get the angle of the segment
-`segAng(rectangleSegmentA001)`.
+A tag created using a tag declarator can be used by writing its name without the `$`, e.g., `myTag`.
+Where necessary to disambiguate from tag declarations, we call these tag identifiers.
 
-### `Start`
+In the example above we use the tag identifier `rectangleSegmentA001` to get the angle of the segment
+using `segAng(rectangleSegmentA001)`.
 
-There is a special tag, `START` (with type `Start`, although under the cover, it's a string)
-for identifying the face of a solid which was the start of an extrusion (i.e., the surface which
-is extruded).
+Tags can identify either an edge or face of a solid, or a line or other edge of a sketch. Functions
+which take a tag identifier as an argument will use either [`TaggedEdge`](/docs/kcl-std/types/std-types-TaggedEdge) (for the edge of a
+solid or sketch) or [`TaggedFace`](/docs/kcl-std/types/std-types-TaggedFace).
 
-### `End`
+If a line in a sketch is tagged and then the sketch is extruded, the tag is a `TaggedEdge` before
+extrusion and a `TaggedFace` after extrusion.
+
+#### `START` and `END`
+
+[`START`](/docs/kcl-std/consts/std-START) and [`END`](/docs/kcl-std/consts/std-END) are special tags
+for identifying the starting and ending faces of an extruded solid.
 
-There is a special tag, `END` (with type `End`, although under the cover, it's a string)
-for identifying the face of a solid which was finishes an extrusion.
 
 ### Tag Scope
 

docs/kcl-std/consts.md

@@ -1,33 +0,0 @@
----
-title: "KCL Constants"
-excerpt: "Documentation for the KCL constants."
-layout: manual
----
-
-## Table of Contents
-
-
-### `std`
-
-- [`END`](/docs/kcl/consts/std-END)
-- [`START`](/docs/kcl/consts/std-START)
-- [`X`](/docs/kcl/consts/std-X)
-- [`XY`](/docs/kcl/consts/std-XY)
-- [`XZ`](/docs/kcl/consts/std-XZ)
-- [`Y`](/docs/kcl/consts/std-Y)
-- [`YZ`](/docs/kcl/consts/std-YZ)
-- [`Z`](/docs/kcl/consts/std-Z)
-
-### `std::math`
-
-- [`E`](/docs/kcl/consts/std-math-E)
-- [`PI`](/docs/kcl/consts/std-math-PI)
-- [`TAU`](/docs/kcl/consts/std-math-TAU)
-
-### `std::turns`
-
-- [`HALF_TURN`](/docs/kcl/consts/std-turns-HALF_TURN)
-- [`QUARTER_TURN`](/docs/kcl/consts/std-turns-QUARTER_TURN)
-- [`THREE_QUARTER_TURN`](/docs/kcl/consts/std-turns-THREE_QUARTER_TURN)
-- [`ZERO`](/docs/kcl/consts/std-turns-ZERO)
-

docs/kcl-std/consts/std-END.md

@@ -8,9 +8,13 @@ layout: manual
 Identifies the ending face of an extrusion. I.e., the new face created by an extrusion.
 
 ```kcl
-END: string = 'end'
+END: TaggedFace
 ```
 
 
 
+### Type
+
+[`TaggedFace`](/docs/kcl-std/types/std-types-TaggedFace) - A tag which references a face of a solid, including the distinguished tags `START` and `END`.
+
 

docs/kcl-std/consts/std-START.md

@@ -8,9 +8,13 @@ layout: manual
 Identifies the starting face of an extrusion. I.e., the face which is extruded.
 
 ```kcl
-START: string = 'start'
+START: TaggedFace
 ```
 
 
 
+### Type
+
+[`TaggedFace`](/docs/kcl-std/types/std-types-TaggedFace) - A tag which references a face of a solid, including the distinguished tags `START` and `END`.
+
 

docs/kcl-std/consts/std-X.md

@@ -8,9 +8,13 @@ layout: manual
 The X-axis (can be used in both 2d and 3d contexts).
 
 ```kcl
-X
+X: Axis3d
 ```
 
 
 
+### Type
+
+[`Axis3d`](/docs/kcl-std/types/std-types-Axis3d) - An abstract and infinite line in 3d space.
+
 

docs/kcl-std/consts/std-XY.md

@@ -8,9 +8,13 @@ layout: manual
 An abstract 3d plane aligned with the X and Y axes. Its normal is the positive Z axis.
 
 ```kcl
-XY
+XY: Plane
 ```
 
 
 
+### Type
+
+[`Plane`](/docs/kcl-std/types/std-types-Plane) - An abstract plane.
+
 

docs/kcl-std/consts/std-XZ.md

@@ -8,9 +8,13 @@ layout: manual
 An abstract 3d plane aligned with the X and Z axes. Its normal is the negative Y axis.
 
 ```kcl
-XZ
+XZ: Plane
 ```
 
 
 
+### Type
+
+[`Plane`](/docs/kcl-std/types/std-types-Plane) - An abstract plane.
+
 

docs/kcl-std/consts/std-Y.md

@@ -8,9 +8,13 @@ layout: manual
 The Y-axis (can be used in both 2d and 3d contexts).
 
 ```kcl
-Y
+Y: Axis3d
 ```
 
 
 
+### Type
+
+[`Axis3d`](/docs/kcl-std/types/std-types-Axis3d) - An abstract and infinite line in 3d space.
+
 

docs/kcl-std/consts/std-YZ.md

@@ -8,9 +8,13 @@ layout: manual
 An abstract 3d plane aligned with the Y and Z axes. Its normal is the positive X axis.
 
 ```kcl
-YZ
+YZ: Plane
 ```
 
 
 
+### Type
+
+[`Plane`](/docs/kcl-std/types/std-types-Plane) - An abstract plane.
+
 

docs/kcl-std/consts/std-Z.md

@@ -8,9 +8,13 @@ layout: manual
 The 3D Z-axis.
 
 ```kcl
-Z
+Z: Axis3d
 ```
 
 
 
+### Type
+
+[`Axis3d`](/docs/kcl-std/types/std-types-Axis3d) - An abstract and infinite line in 3d space.
+
 

docs/kcl-std/consts/std-sweep-SKETCH_PLANE.md

@@ -13,4 +13,8 @@ sweep::SKETCH_PLANE: string = 'sketchPlane'
 
 
 
+### Type
+
+[`string`](/docs/kcl-std/types/std-types-string) - A sequence of characters
+
 

docs/kcl-std/consts/std-sweep-TRAJECTORY.md

@@ -13,4 +13,8 @@ sweep::TRAJECTORY: string = 'trajectoryCurve'
 
 
 
+### Type
+
+[`string`](/docs/kcl-std/types/std-types-string) - A sequence of characters
+
 

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

@@ -13,4 +13,8 @@ turns::HALF_TURN: number(deg) = 180deg
 
 
 
+### Type
+
+[`number(deg)`](/docs/kcl-std/types/std-types-number) - A number.
+
 

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

@@ -13,4 +13,8 @@ turns::QUARTER_TURN: number(deg) = 90deg
 
 
 
+### Type
+
+[`number(deg)`](/docs/kcl-std/types/std-types-number) - A number.
+
 

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

@@ -13,4 +13,8 @@ turns::THREE_QUARTER_TURN: number(deg) = 270deg
 
 
 
+### Type
+
+[`number(deg)`](/docs/kcl-std/types/std-types-number) - A number.
+
 

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

@@ -8,9 +8,13 @@ layout: manual
 No turn, zero degrees/radians.
 
 ```kcl
-turns::ZERO: number = 0
+turns::ZERO: number(Angle)
 ```
 
 
 
+### Type
+
+[`number(Angle)`](/docs/kcl-std/types/std-types-number) - A number.
+
 

docs/kcl-std/functions/std-assert.md

@@ -1,11 +1,11 @@
 ---
 title: "assert"
 subtitle: "Function in std"
-excerpt: ""
+excerpt: "Check a value meets some expected conditions at runtime. Program terminates with an error if conditions aren't met. If you provide multiple conditions, they will all be checked and all must be met."
 layout: manual
 ---
 
-
+Check a value meets some expected conditions at runtime. Program terminates with an error if conditions aren't met. If you provide multiple conditions, they will all be checked and all must be met.
 
 ```kcl
 assert(
@@ -20,8 +20,7 @@ assert(
 )
 ```
 
-Check a value meets some expected conditions at runtime. Program terminates with an error if conditions aren't met.
-If you provide multiple conditions, they will all be checked and all must be met.
+
 
 ### Arguments
 
@@ -42,8 +41,19 @@ If you provide multiple conditions, they will all be checked and all must be met
 ```kcl
 n = 10
 assert(n, isEqualTo = 10)
-assert(n, isGreaterThanOrEqual = 0, isLessThan = 100, error = "number should be between 0 and 100")
-assert(1.0000000000012, isEqualTo = 1, tolerance = 0.0001, error = "number should be almost exactly 1")
+assert(
+  n,
+  isGreaterThanOrEqual = 0,
+  isLessThan = 100,
+  error = "number should be between 0 and 100",
+)
+assert(
+  1.0000000000012,
+  isEqualTo = 1,
+  tolerance = 0.0001,
+  error = "number should be almost exactly 1",
+)
+
 ```
 
 

docs/kcl-std/functions/std-assertIs.md

@@ -29,6 +29,7 @@ assertIs(
 ```kcl
 kclIsFun = true
 assertIs(kclIsFun)
+
 ```
 
 

docs/kcl-std/functions/std-math-atan.md

@@ -29,14 +29,12 @@ Consider using `atan2()` instead for the true inverse of tangent.
 ```kcl
 sketch001 = startSketchOn(XZ)
   |> startProfile(at = [0, 0])
-  |> angledLine(
-    angle = atan(1.25),
-    length = 20,
-  )
+  |> angledLine(angle = atan(1.25), length = 20)
   |> yLine(endAbsolute = 0)
   |> close()
 
 extrude001 = extrude(sketch001, length = 5)
+
 ```
 
 

docs/kcl-std/functions/std-math-legAngX.md

@@ -32,6 +32,7 @@ legAngX(
 
 ```kcl
 legAngX(hypotenuse = 5, leg = 3)
+
 ```
 
 

docs/kcl-std/functions/std-math-legAngY.md

@@ -32,6 +32,7 @@ legAngY(
 
 ```kcl
 legAngY(hypotenuse = 5, leg = 3)
+
 ```
 
 

docs/kcl-std/functions/std-math-legLen.md

@@ -32,6 +32,7 @@ legLen(
 
 ```kcl
 legLen(hypotenuse = 5, leg = 3)
+
 ```