diff --git a/.coderabbit.yaml b/.coderabbit.yaml new file mode 100644 index 000000000..a2f964aeb --- /dev/null +++ b/.coderabbit.yaml @@ -0,0 +1,20 @@ +# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json +reviews: + auto_review: + # Dependabot bumps are checked by CI; skip CodeRabbit reviews on them. + ignore_usernames: + - "dependabot[bot]" + path_instructions: + - path: "**" + instructions: | + Project rule: don't change anyone's existing defaults unless the change is purely additive and belongs in the application. + Flag any change to something a user already relies on: a default setting or preference value, what a command or tool does when used the usual way, the UI's default layout or behaviour, a keyboard or mouse shortcut, or the result an existing saved design rebuilds to. + Don't flag purely additive changes: a new command, a new setting whose default keeps today's behaviour, or a new option that appears only when someone chooses it. Don't flag bug fixes that only turn a crash or an error into the result the feature always promised. + When you flag one, start the comment with "Changes a default:", say what a user sees before and after, whether a setting keeps the old behaviour, and whether the PR description's `Changes a default:` line says so. + pre_merge_checks: + custom_checks: + - name: "Existing defaults unchanged" + mode: "warning" + instructions: | + Pass if the pull request changes no default a user already relies on (default setting or preference values, what a command or tool does when used the usual way, the UI's default layout or behaviour, shortcuts, or the result an existing saved design rebuilds to), or if its changes are purely additive. + Fail otherwise, naming each changed default and what a user sees before and after. Also fail if the description says `Changes a default: no` while the code changes one. diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 1e6eb5806..26e12d113 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -442,9 +442,6 @@ jobs: with: key: quick-compile save-if: ${{ github.ref == 'refs/heads/main' || github.ref == 'refs/heads/develop' }} - - name: Fetch SMLib (crates/smlib/SMLIB_REV) - shell: bash - run: scripts/fetch-smlib.sh - name: Cargo check run: cargo check --workspace --all-targets --locked @@ -464,9 +461,6 @@ jobs: with: key: native-clippy save-if: ${{ github.ref == 'refs/heads/main' || github.ref == 'refs/heads/develop' }} - - name: Fetch SMLib (crates/smlib/SMLIB_REV) - shell: bash - run: scripts/fetch-smlib.sh - name: Clippy env: FULL: ${{ needs.changes.outputs.full }} @@ -510,9 +504,6 @@ jobs: with: key: native-tests save-if: ${{ github.ref == 'refs/heads/main' || github.ref == 'refs/heads/develop' }} - - name: Fetch SMLib (crates/smlib/SMLIB_REV) - shell: bash - run: scripts/fetch-smlib.sh - name: Set up compiler cache uses: mozilla-actions/sccache-action@fc920bf0ec8de6ee65d409111f7ec508035751ba # v0.0.11 with: @@ -584,9 +575,6 @@ jobs: with: key: native-tests save-if: ${{ github.ref == 'refs/heads/main' || github.ref == 'refs/heads/develop' }} - - name: Fetch SMLib (crates/smlib/SMLIB_REV) - shell: bash - run: scripts/fetch-smlib.sh - name: Set up compiler cache uses: mozilla-actions/sccache-action@fc920bf0ec8de6ee65d409111f7ec508035751ba # v0.0.11 with: @@ -703,9 +691,6 @@ jobs: with: key: native-gpu save-if: ${{ (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/develop') && matrix.shard == 1 }} - - name: Fetch SMLib (crates/smlib/SMLIB_REV) - shell: bash - run: scripts/fetch-smlib.sh - name: Set up compiler cache uses: mozilla-actions/sccache-action@fc920bf0ec8de6ee65d409111f7ec508035751ba # v0.0.11 with: @@ -862,9 +847,6 @@ jobs: with: key: doc-tests save-if: ${{ github.ref == 'refs/heads/main' || github.ref == 'refs/heads/develop' }} - - name: Fetch SMLib (crates/smlib/SMLIB_REV) - shell: bash - run: scripts/fetch-smlib.sh - name: Set up compiler cache uses: mozilla-actions/sccache-action@fc920bf0ec8de6ee65d409111f7ec508035751ba # v0.0.11 with: @@ -923,9 +905,6 @@ jobs: with: key: oracle save-if: ${{ github.ref == 'refs/heads/main' || github.ref == 'refs/heads/develop' }} - - name: Fetch SMLib (crates/smlib/SMLIB_REV) - shell: bash - run: scripts/fetch-smlib.sh - name: Set up compiler cache uses: mozilla-actions/sccache-action@fc920bf0ec8de6ee65d409111f7ec508035751ba # v0.0.11 with: @@ -965,9 +944,6 @@ jobs: with: key: windows-fxc save-if: ${{ github.ref == 'refs/heads/main' || github.ref == 'refs/heads/develop' }} - - name: Fetch SMLib (crates/smlib/SMLIB_REV) - shell: bash - run: scripts/fetch-smlib.sh # One test at a time: WARP's shader JIT crashes now and then (a null read in # d3d10warp.dll's JIT optimizer, about 1 run in 60) when several devices compile compute # pipelines at once, which the parallel tests do. Minidumps showed it in WARP itself, not @@ -992,9 +968,6 @@ jobs: with: key: windows-startup save-if: ${{ github.ref == 'refs/heads/main' || github.ref == 'refs/heads/develop' }} - - name: Fetch SMLib (crates/smlib/SMLIB_REV) - shell: bash - run: scripts/fetch-smlib.sh - name: Backend order and probing on Windows run: cargo test -p solidcraft --profile ci --locked -- startup::tests native_crash::tests native_frame::tests - name: Build the app @@ -1132,9 +1105,6 @@ jobs: with: key: wasm save-if: ${{ github.ref == 'refs/heads/main' || github.ref == 'refs/heads/develop' }} - - name: Fetch SMLib (crates/smlib/SMLIB_REV) - shell: bash - run: scripts/fetch-smlib.sh wasm32-unknown-unknown - run: cargo xtask wasm riscv64-gates: @@ -1157,9 +1127,6 @@ jobs: with: key: riscv64 save-if: ${{ github.ref == 'refs/heads/main' || github.ref == 'refs/heads/develop' }} - - name: Fetch SMLib (crates/smlib/SMLIB_REV) - shell: bash - run: scripts/fetch-smlib.sh riscv64gc-unknown-linux-gnu - name: Install cross-compilation dependencies run: | # Ubuntu's regular archive serves amd64; RISC-V packages live in ports. @@ -1180,8 +1147,6 @@ jobs: - name: Cargo check on RISC-V env: CARGO_TARGET_RISCV64GC_UNKNOWN_LINUX_GNU_LINKER: riscv64-linux-gnu-gcc - # SMLib has no prebuilt library for RISC-V: its sources are compiled with this. - CXX_riscv64gc_unknown_linux_gnu: riscv64-linux-gnu-g++ PKG_CONFIG_SYSROOT_DIR: / PKG_CONFIG_PATH: /usr/lib/riscv64-linux-gnu/pkgconfig:/usr/share/pkgconfig PKG_CONFIG_ALLOW_CROSS: 1 diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml index cf1c39691..0e7d17e09 100644 --- a/.github/workflows/docker.yml +++ b/.github/workflows/docker.yml @@ -53,9 +53,6 @@ jobs: with: key: docker-web save-if: ${{ github.ref == 'refs/heads/main' }} - - name: Fetch SMLib (crates/smlib/SMLIB_REV) - shell: bash - run: scripts/fetch-smlib.sh wasm32-unknown-unknown - name: Install trunk run: | mkdir -p "$HOME/.local/bin" diff --git a/.github/workflows/external-corpus.yml b/.github/workflows/external-corpus.yml index 8267eff1f..f43515a60 100644 --- a/.github/workflows/external-corpus.yml +++ b/.github/workflows/external-corpus.yml @@ -29,9 +29,6 @@ jobs: steps: - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 - uses: dtolnay/rust-toolchain@stable - - name: Fetch SMLib (crates/smlib/SMLIB_REV) - shell: bash - run: scripts/fetch-smlib.sh - name: Build the CLI run: cargo build --profile ci -p solidcraft-cli - name: Import and check every entry diff --git a/.github/workflows/fillet-rig.yml b/.github/workflows/fillet-rig.yml index 57098f113..166e1f11d 100644 --- a/.github/workflows/fillet-rig.yml +++ b/.github/workflows/fillet-rig.yml @@ -1,5 +1,5 @@ # The fillet rig as a regression gate: a pull request that touches fillet code (the paths below) -# runs every case in tests/kernel-cases/fillets/ on SMLib, through one release build of +# runs every case in tests/kernel-cases/fillets/ through one release build of # solidcraft-cli, and fails on a regression (a case that fails and # tests/kernel-cases/fillets/KNOWN_FAILING does not list) or on a listed case that now passes # (it is fixed: remove its line, so the list only shrinks). See tests/kernel-cases/README.md. @@ -25,7 +25,6 @@ on: # The rig itself: the grading, the runner and this workflow. - "apps/solidcraft-cli/src/kernel_cases.rs" - "xtask/src/kernel_cases.rs" - - "scripts/fetch-smlib.sh" - ".github/workflows/fillet-rig.yml" push: branches: [main, develop] @@ -42,7 +41,6 @@ on: # The rig itself: the grading, the runner and this workflow. - "apps/solidcraft-cli/src/kernel_cases.rs" - "xtask/src/kernel_cases.rs" - - "scripts/fetch-smlib.sh" - ".github/workflows/fillet-rig.yml" workflow_dispatch: @@ -86,15 +84,12 @@ jobs: with: key: fillet-rig save-if: ${{ github.ref == 'refs/heads/main' || github.ref == 'refs/heads/develop' }} - - name: Fetch SMLib (crates/smlib/SMLIB_REV) - shell: bash - run: scripts/fetch-smlib.sh - name: Set up compiler cache uses: mozilla-actions/sccache-action@fc920bf0ec8de6ee65d409111f7ec508035751ba # v0.0.11 with: version: v0.16.0 - - name: Build the CLI (release, SMLib) - run: cargo build --release --locked -p solidcraft-cli --features smlib + - name: Build the CLI (release) + run: cargo build --release --locked -p solidcraft-cli - name: Run the fillet cases against the known-failing list run: >- cargo run -q --locked -p xtask -- kernel-cases --area fillets diff --git a/.github/workflows/flatpak-pages.yml b/.github/workflows/flatpak-pages.yml index 06e5e6a2e..4cc41f698 100644 --- a/.github/workflows/flatpak-pages.yml +++ b/.github/workflows/flatpak-pages.yml @@ -21,6 +21,8 @@ concurrency: jobs: publish: name: Request the combined docs, web, and Flatpak deployment + # A pre-release stays off the Flatpak feed: the feed's one branch is what `flatpak update` offers. + if: github.event_name == 'workflow_dispatch' || !github.event.release.prerelease runs-on: ubuntu-24.04 env: GH_TOKEN: ${{ github.token }} diff --git a/.github/workflows/generated.yml b/.github/workflows/generated.yml index abe627d32..b70b1338a 100644 --- a/.github/workflows/generated.yml +++ b/.github/workflows/generated.yml @@ -48,9 +48,6 @@ jobs: - uses: Swatinem/rust-cache@6323deb102c322ba6fcbdcafc7e3dddab59af2b6 # v2.9.2 with: key: generated-files - - name: Fetch SMLib (crates/smlib/SMLIB_REV) - shell: bash - run: scripts/fetch-smlib.sh - name: THIRD-PARTY-LICENSES.txt run: cargo xtask licences - name: docs/features.md diff --git a/.github/workflows/kernel-rig.yml b/.github/workflows/kernel-rig.yml index ba811a7fb..a4a7d6387 100644 --- a/.github/workflows/kernel-rig.yml +++ b/.github/workflows/kernel-rig.yml @@ -1,8 +1,9 @@ # The kernel rig and the complexity ladder as a regression gate. A plan job maps a pull request's # changed files to the rig areas they can affect (scripts/ci/kernel_rig_plan.py): an area runs # when a file its tests/kernel-cases//PATHS lists changes, or one of its cases; every area -# runs when the shared core in tests/kernel-cases/PATHS-ALL changes; the ladder runs whenever any -# area does. One job then builds solidcraft-cli once (release, SMLib prebuilt), checks that every +# runs when the shared core in tests/kernel-cases/PATHS-ALL changes, and when the solidcore pin in +# the root Cargo.toml and Cargo.lock moves (the plan reads their diff); the ladder runs whenever any +# area does. One job then builds solidcraft-cli once (release), checks that every # registry command has a case or an exemption (tests/kernel-cases/EXEMPT), and hands the CLI to a # matrix of shards as an artifact, one per selected area plus the ladder, in parallel, so the # wall time is the build plus the slowest shard. See tests/kernel-cases/README.md. @@ -34,11 +35,13 @@ on: - "crates/doc/src/**" - "crates/engine/src/**" - "tests/kernel-cases/**" + # The solidcore pin (the plan runs every area only when its lines change). + - "Cargo.toml" + - "Cargo.lock" # The rig itself: the grading, the runner, the selection and this workflow. - "apps/solidcraft-cli/src/kernel_cases.rs" - "xtask/src/kernel_cases.rs" - "xtask/src/kernel_ladder.rs" - - "scripts/fetch-smlib.sh" - "scripts/ci/kernel_rig_plan.py" - "scripts/ci/test_kernel_rig_plan.py" - ".github/workflows/kernel-rig.yml" @@ -54,11 +57,13 @@ on: - "crates/doc/src/**" - "crates/engine/src/**" - "tests/kernel-cases/**" + # The solidcore pin (the plan runs every area only when its lines change). + - "Cargo.toml" + - "Cargo.lock" # The rig itself: the grading, the runner, the selection and this workflow. - "apps/solidcraft-cli/src/kernel_cases.rs" - "xtask/src/kernel_cases.rs" - "xtask/src/kernel_ladder.rs" - - "scripts/fetch-smlib.sh" - "scripts/ci/kernel_rig_plan.py" - "scripts/ci/test_kernel_rig_plan.py" - ".github/workflows/kernel-rig.yml" @@ -107,7 +112,9 @@ jobs: # gate and a run by hand run every area. if [ "$EVENT_NAME" = pull_request ]; then git diff --no-renames --name-only -z "$BASE_SHA...$HEAD_SHA" > "$RUNNER_TEMP/rig-paths" - python3 -I scripts/ci/kernel_rig_plan.py --paths "$RUNNER_TEMP/rig-paths" --github-output "$GITHUB_OUTPUT" + git diff --no-renames "$BASE_SHA...$HEAD_SHA" -- Cargo.toml Cargo.lock > "$RUNNER_TEMP/rig-pin.diff" + python3 -I scripts/ci/kernel_rig_plan.py --paths "$RUNNER_TEMP/rig-paths" --pin-diff "$RUNNER_TEMP/rig-pin.diff" \ + --github-output "$GITHUB_OUTPUT" else python3 -I scripts/ci/kernel_rig_plan.py --all --github-output "$GITHUB_OUTPUT" fi @@ -141,16 +148,13 @@ jobs: with: key: kernel-rig save-if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/develop') }} - - name: Fetch SMLib (crates/smlib/SMLIB_REV) - shell: bash - run: scripts/fetch-smlib.sh - name: Set up compiler cache uses: mozilla-actions/sccache-action@fc920bf0ec8de6ee65d409111f7ec508035751ba # v0.0.11 with: version: v0.16.0 - - name: Build the CLI (release, SMLib) and the rig's runner + - name: Build the CLI (release) and the rig's runner run: | - cargo build --release --locked -p solidcraft-cli --features smlib + cargo build --release --locked -p solidcraft-cli cargo build --locked -p xtask # A tar keeps the executable bits, which an artifact drops. xtask finds the repository from # the path it was built in (CARGO_MANIFEST_DIR), which is the same checkout path in every @@ -209,7 +213,7 @@ jobs: uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2 with: name: kernel-rig-results-${{ matrix.shard }} - path: ${{ runner.temp }}/kernel-rig/results.json + path: ${{ runner.temp }}/kernel-rig/**/results.json if-no-files-found: ignore # One check for the whole gate, for branch protection and the merge queue. diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index ea87218cd..cfac788fb 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -1,5 +1,6 @@ # The documentation site on GitHub Pages: the book (docs/book) at https://docs.solidcraft.io/ -# and the bundled web app at /app/. Needs Settings → Pages → Source = GitHub Actions; skipped while the +# and the web app at /app/ (the latest release), /app-rc/ (the newest release candidate) and +# /app-edge/ (this commit). Needs Settings → Pages → Source = GitHub Actions; skipped while the # repository is private. name: Pages @@ -41,9 +42,6 @@ jobs: with: targets: wasm32-unknown-unknown - uses: Swatinem/rust-cache@6323deb102c322ba6fcbdcafc7e3dddab59af2b6 # v2.9.2 - - name: Fetch SMLib (crates/smlib/SMLIB_REV) - shell: bash - run: scripts/fetch-smlib.sh wasm32-unknown-unknown - name: Install mdbook and trunk run: | mkdir -p "$HOME/.local/bin" @@ -69,7 +67,10 @@ jobs: mkdir -p site cp -r target/book/. site/ bash docs/book/seo.sh site # canonical links, robots.txt, sitemap.xml - cp -r dist/web site/app + - name: Add the web app channels (stable and release candidate from their releases, edge from this build) + env: + GH_TOKEN: ${{ github.token }} + run: bash packaging/web-channels.sh site dist/web - uses: actions/configure-pages@v5 id: pages - name: Install Flatpak repository tools diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 5882ba943..d1d192344 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -126,9 +126,6 @@ jobs: - uses: Swatinem/rust-cache@6323deb102c322ba6fcbdcafc7e3dddab59af2b6 # v2.9.2 with: key: release-icons - - name: Fetch SMLib (crates/smlib/SMLIB_REV) - shell: bash - run: scripts/fetch-smlib.sh - run: cargo build --release --locked -p solidcraft-cli - run: | . packaging/env.sh @@ -168,9 +165,6 @@ jobs: - uses: Swatinem/rust-cache@6323deb102c322ba6fcbdcafc7e3dddab59af2b6 # v2.9.2 with: key: release-linux-${{ matrix.arch }} - - name: Fetch SMLib (crates/smlib/SMLIB_REV) - shell: bash - run: scripts/fetch-smlib.sh - name: Build and package (AppImage, deb, rpm, tar.gz) run: packaging/linux/package.sh - name: Check the packages @@ -240,6 +234,8 @@ jobs: if: needs.version.outputs.build == 'true' # makepkg only repackages the tarball's prebuilt binaries, so both architectures build here. runs-on: ubuntu-24.04 + # A pre-release or nightly without an Arch package is still worth having; a stable release isn't. + continue-on-error: ${{ contains(needs.version.outputs.version, '-') }} strategy: fail-fast: false matrix: @@ -256,10 +252,29 @@ jobs: # makepkg in an archlinux:base-devel container. The package is named after the tarball's # .desktop file (io.tangencylabs.solidcraft) and written as # dist/release/solidcraft--linux-.pkg.tar.zst. + # An Arch version can't hold a hyphen, and the action reads the version from the tarball's name + # (a hyphenated one comes out as 0.0.0): 0.40.0-rc.1 goes in as 0.40.0rc.1, which pacman sorts + # before 0.40.0, and the package keeps the release's name. + - id: pkgver + name: Arch version + run: | + pkgver="${VERSION//-/}" + echo "pkgver=$pkgver" >>"$GITHUB_OUTPUT" + if [ "$pkgver" != "$VERSION" ]; then + cp "dist/linux/solidcraft-$VERSION-linux-$ARCH.tar.gz" "dist/linux/solidcraft-$pkgver-linux-$ARCH.tar.gz" + fi + env: + ARCH: ${{ matrix.arch }} - uses: storytold/craft-common-actions/actions/arch-package@fa5ef18780cf5e7d5d3b8de068de56cffc83cac5 # main with: - tarball: dist/linux/solidcraft-${{ env.VERSION }}-linux-${{ matrix.arch }}.tar.gz + tarball: dist/linux/solidcraft-${{ steps.pkgver.outputs.pkgver }}-linux-${{ matrix.arch }}.tar.gz arch: ${{ matrix.arch }} + - name: The package under the release's version + if: steps.pkgver.outputs.pkgver != env.VERSION + env: + ARCH: ${{ matrix.arch }} + PKGVER: ${{ steps.pkgver.outputs.pkgver }} + run: sudo mv "dist/release/solidcraft-$PKGVER-linux-$ARCH.pkg.tar.zst" "dist/release/solidcraft-$VERSION-linux-$ARCH.pkg.tar.zst" - name: Check the package env: PKG: dist/release/solidcraft-${{ env.VERSION }}-linux-${{ matrix.arch }}.pkg.tar.zst @@ -395,9 +410,6 @@ jobs: - uses: Swatinem/rust-cache@6323deb102c322ba6fcbdcafc7e3dddab59af2b6 # v2.9.2 with: key: release-macos-${{ matrix.arch }} - - name: Fetch SMLib (crates/smlib/SMLIB_REV) - shell: bash - run: scripts/fetch-smlib.sh ${{ matrix.target }} - name: Build run: packaging/macos/package.sh --build-only ${{ matrix.target }} # Not named release-*: the release job collects every release-* artifact as an asset. @@ -496,9 +508,6 @@ jobs: - uses: Swatinem/rust-cache@6323deb102c322ba6fcbdcafc7e3dddab59af2b6 # v2.9.2 with: key: release-windows-${{ matrix.arch }} - - name: Fetch SMLib (crates/smlib/SMLIB_REV) - shell: bash - run: scripts/fetch-smlib.sh ${{ matrix.target }} - name: Install WiX shell: pwsh run: | @@ -630,9 +639,6 @@ jobs: - uses: Swatinem/rust-cache@6323deb102c322ba6fcbdcafc7e3dddab59af2b6 # v2.9.2 with: key: release-web - - name: Fetch SMLib (crates/smlib/SMLIB_REV) - shell: bash - run: scripts/fetch-smlib.sh wasm32-unknown-unknown - name: Install trunk run: | curl -fsSL "https://github.com/trunk-rs/trunk/releases/download/v${TRUNK_VERSION}/trunk-x86_64-unknown-linux-gnu.tar.gz" \ diff --git a/.gitignore b/.gitignore index 96e9fa55b..6d085a6b5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,7 @@ /target*/ /plan/ /dist/ +/docs/vibemake/evidence *~ .DS_Store *.swp diff --git a/AGENTS.md b/AGENTS.md index f88775e27..cbd819226 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -3,14 +3,15 @@ SolidCraft is a clean-room, pure-Rust parametric 3D CAD app (sketch solver, feature timeline, B-rep kernel, an egui UI that agents drive). This file is a router: the hard rules, then the skill to read for your task. Humans: CONTRIBUTING.md. ## Start here -Work: ROADMAP.md, "Where help is wanted most" in CONTRIBUTING.md, issues labelled `help wanted`, `good first issue`, `needs-triage`; architecture in `docs/architecture.md`. Act when the code, docs and rules settle a question; ask only when it changes what users see. Local `plan/` notes are optional. +Work: ROADMAP.md, "Where help is wanted most" in CONTRIBUTING.md, issues labelled `help wanted`, `good first issue`, `needs-triage`; architecture in `docs/architecture.md`. Local `plan/` notes are optional. ## Hard rules (what enforces each) - Independent: never copy another product's code, icons, text or templates; never drive or take data from commercial CAD. `skills/solidcraft-ground-rules/SKILL.md`. - No GPL/LGPL/AGPL code, not even reading it (OpenCASCADE, FreeCAD, SolveSpace, CadQuery, LibreCAD, QCAD): `cargo xtask licences --check`. - Every asset is original or openly licensed with a row in ATTRIBUTION.md; read `assets/AGENTS.md` before icon work: `cargo xtask assets`, `cargo xtask icons`. -- Never crash: no unwrap/expect/panic/unsafe in non-test code (unsafe allowlist in crash-safety), errors are `Result`, input is hostile: clippy `-D warnings`, `hostile_params_never_panic`. +- Never crash: no unwrap/expect/panic/unsafe in non-test code, errors are `Result`, input is hostile: clippy `-D warnings`, `hostile_params_never_panic`. - Model decisions (what an operation does, which bodies it touches, which face or edge a point or name means, depths, nearness) use exact geometry; a mesh is for display, export, previews and mesh bodies (`xtask/mesh-decisions.txt` only shrinks): `cargo xtask mesh-decisions`. +- New kernel cases go to solidcore: `cargo xtask lists`. - Everything is a command and programmatic calls never open dialogs: `skills/solidcraft-commands/SKILL.md`. - Layering (geom, sketch/kernel/render, doc, io, engine, ui-egui, apps); only `crates/kernel` uses truck: `cargo xtask layers`. - One outer UI container, one camera path (`navigation::handle`), colours from theme tokens: `cargo xtask ui-containers`. @@ -20,12 +21,14 @@ Work: ROADMAP.md, "Where help is wanted most" in CONTRIBUTING.md, issues labelle - A design-format change is ONE new file in `crates/doc/src/format/pending/`: `scripts/test-format-pending.sh`. - A command has input and output schemas (will become required; `schema/unconverted.txt` only shrinks): `skills/solidcraft-commands/SKILL.md`. - New UI strings go in `assets/locales/pending/.json`, ATTRIBUTION rows in `attribution/pending/.md`: `cargo xtask lists`. -- A changed default keeps the old behaviour behind a preference and fills the PR's `Changes a default:` line, and no second PR for an issue a lower-numbered one closes: `pr-checks.yml`. +- A changed default keeps the old behaviour behind a preference and fills the PR's `Changes a default:` line: `pr-checks.yml`. - A regression test goes in the area's existing test file, never a per-bug file (#3226). -- Look at open PRs first, claim with a draft PR (lowest number wins), one topic per PR, never force-push `main`, no pushes just to catch up with `main`: `skills/solidcraft-contributing/SKILL.md`. +- Look at open PRs first, claim with a draft PR (lowest number wins), one topic per PR: `skills/solidcraft-contributing/SKILL.md`. - A PR's title and first sentence make sense to someone who never saw your chat or the issue: `skills/solidcraft-contributing/SKILL.md`. +- Code, comments, commit messages and docs are in English, always: `skills/solidcraft-contributing/SKILL.md` ("Working as an agent"). +- Independent work runs in parallel, dependent work stays sequential: `skills/solidcraft-contributing/SKILL.md` ("Working as an agent"). - Show observable changes with real screenshots or a recording, captured yourself. -- Run `cargo xtask ci` before every commit, without switching branches while it runs. `cargo xtask skills` keeps this file and `skills/` honest. +- Run `cargo xtask ci` before every commit. `cargo xtask skills` keeps this file and `skills/` honest. ## Working on X: read the skill first | Working on | Read | diff --git a/ATTRIBUTION.md b/ATTRIBUTION.md index e41401c43..17350dbb5 100644 --- a/ATTRIBUTION.md +++ b/ATTRIBUTION.md @@ -245,6 +245,18 @@ Editable drawing code, native projects and shipped exports are collected under ` | assets/icons/ui/design/svg/flat/plus.svg | SolidCraft contributors | single-colour application/navigation icon master (64 grid), original SolidCraft artwork | MIT OR Apache-2.0 | | assets/icons/ui/design/svg/flat/pan.svg | SolidCraft contributors | single-colour application/navigation icon master (64 grid), original SolidCraft artwork | MIT OR Apache-2.0 | | assets/icons/ui/design/svg/flat/perspective.svg | SolidCraft contributors | single-colour application/navigation icon master (64 grid), original SolidCraft artwork | MIT OR Apache-2.0 | +| assets/icons/ui/design/svg/flat/prefs_appearance.svg | SolidCraft contributors | original icon master (64 grid) | MIT OR Apache-2.0 | +| assets/icons/ui/design/svg/flat/prefs_assistant.svg | SolidCraft contributors | original icon master (64 grid) | MIT OR Apache-2.0 | +| assets/icons/ui/design/svg/flat/prefs_design.svg | SolidCraft contributors | original icon master (64 grid) | MIT OR Apache-2.0 | +| assets/icons/ui/design/svg/flat/prefs_general.svg | SolidCraft contributors | original icon master (64 grid) | MIT OR Apache-2.0 | +| assets/icons/ui/design/svg/flat/prefs_graphics.svg | SolidCraft contributors | original icon master (64 grid) | MIT OR Apache-2.0 | +| assets/icons/ui/design/svg/flat/prefs_layout.svg | SolidCraft contributors | original icon master (64 grid) | MIT OR Apache-2.0 | +| assets/icons/ui/design/svg/flat/prefs_mouse3d.svg | SolidCraft contributors | original icon master (64 grid) | MIT OR Apache-2.0 | +| assets/icons/ui/design/svg/flat/prefs_navigation.svg | SolidCraft contributors | original icon master (64 grid) | MIT OR Apache-2.0 | +| assets/icons/ui/design/svg/flat/prefs_plugins.svg | SolidCraft contributors | original icon master (64 grid) | MIT OR Apache-2.0 | +| assets/icons/ui/design/svg/flat/prefs_shortcuts.svg | SolidCraft contributors | original icon master (64 grid) | MIT OR Apache-2.0 | +| assets/icons/ui/design/svg/flat/prefs_sketch.svg | SolidCraft contributors | original icon master (64 grid) | MIT OR Apache-2.0 | +| assets/icons/ui/design/svg/flat/prefs_tools.svg | SolidCraft contributors | original icon master (64 grid) | MIT OR Apache-2.0 | | assets/icons/ui/design/svg/flat/redo.svg | SolidCraft contributors | single-colour application/navigation icon master (64 grid), original SolidCraft artwork | MIT OR Apache-2.0 | | assets/icons/ui/design/svg/flat/save.svg | SolidCraft contributors | single-colour application/navigation icon master (64 grid), original SolidCraft artwork | MIT OR Apache-2.0 | | assets/icons/ui/design/svg/flat/settings.svg | SolidCraft contributors | single-colour application/navigation icon master (64 grid), original SolidCraft artwork | MIT OR Apache-2.0 | @@ -305,7 +317,6 @@ Editable drawing code, native projects and shipped exports are collected under ` | assets/icons/ui/design/svg/model/circle_ttt.svg | SolidCraft contributors | two-tone modelling icon master (64 grid), original SolidCraft artwork | MIT OR Apache-2.0 | | assets/icons/ui/design/svg/model/coil.svg | SolidCraft contributors | two-tone modelling icon master (64 grid), original SolidCraft artwork | MIT OR Apache-2.0 | | assets/icons/ui/design/svg/model/colored_components.svg | SolidCraft contributors | original icon master (64 grid) | MIT OR Apache-2.0 | -| assets/icons/ui/design/svg/model/colored_components_off.svg | SolidCraft contributors | original icon master (64 grid) | MIT OR Apache-2.0 | | assets/icons/ui/design/svg/model/combine.svg | SolidCraft contributors | two-tone modelling icon master (64 grid), original SolidCraft artwork | MIT OR Apache-2.0 | | assets/icons/ui/design/svg/model/component.svg | SolidCraft contributors | two-tone modelling icon master (64 grid), original SolidCraft artwork | MIT OR Apache-2.0 | @@ -772,6 +783,50 @@ Original SolidCraft drawings, Open for owner review; no runtime assignments. | `assets/locales/pending/sketch-offset-instances.json` | SolidCraft contributors | Original offset instance-count label and translations | MIT OR Apache-2.0 | | assets/icons/ui/design/svg/flat/settings_profile.svg | SolidCraft contributors | single-colour application/navigation icon master (64 grid), original analytic head and shoulder geometry for settings profiles | MIT OR Apache-2.0 | | tests/kernel-cases/import/4561-convert-box-mesh-with-a-zero-area-triangle/box-degenerate.stl | SolidCraft contributors | synthetic ASCII STL written by hand: a box with one zero-area triangle, for the kernel regression case of tangency-labs/solidcraft#4561 | MIT OR Apache-2.0 | +| assets/locales/pending/theme-blur-ui.json | SolidCraft contributors | Original blur controls, notices and translations | MIT OR Apache-2.0 | +| crates/ui-egui/tests/fixtures/theme-blur.json | SolidCraft contributors | Original theme for blur option scenarios and manager review | MIT OR Apache-2.0 | +| assets/locales/ka.json | David Machakhelidze (devius) | Original Georgian translation of SolidCraft's English catalog, written with Claude Code from the meaning of each English string; terminology and doubtful strings decided by a native Georgian speaker; no commercial CAD text used | MIT OR Apache-2.0 | +| assets/branding/logo/solidcraft-mark.svg | SolidCraft contributors | static SolidCraft mark: the five faces and gradients of assets/icons/app/macos/source/SolidCraft.icon/Assets/03-solid-blue-cutout.svg (the final frame of assets/styles/web/loading-logo.svg), cropped to the mark's bounds; original artwork | MIT OR Apache-2.0 | +| assets/branding/logo/solidcraft-mark-mono-black.svg | SolidCraft contributors | one-colour (black) version of assets/branding/logo/solidcraft-mark.svg, same paths; original artwork | MIT OR Apache-2.0 | +| assets/branding/logo/solidcraft-mark-mono-white.svg | SolidCraft contributors | one-colour (white) version of assets/branding/logo/solidcraft-mark.svg, same paths; original artwork | MIT OR Apache-2.0 | +| assets/branding/logo/solidcraft-mark-512.png | SolidCraft contributors | transparent 512 px render of assets/branding/logo/solidcraft-mark.svg (cairosvg); original artwork | MIT OR Apache-2.0 | +| assets/branding/logo/solidcraft-mark-1024.png | SolidCraft contributors | transparent 1024 px render of assets/branding/logo/solidcraft-mark.svg (cairosvg); original artwork | MIT OR Apache-2.0 | +| assets/branding/logo/solidcraft-mark-2048.png | SolidCraft contributors | transparent 2048 px render of assets/branding/logo/solidcraft-mark.svg (cairosvg); original artwork | MIT OR Apache-2.0 | +| assets/branding/logo/solidcraft-wordmark.svg | SolidCraft contributors | the name SolidCraft set like the loading logo's wordmark (bold, +0.02 em tracking, #15499e) in IBM Plex Sans Bold from assets/fonts/ibm-plex-sans (SIL OFL 1.1, IBM Corp.), outlined to paths; no font file is embedded | MIT OR Apache-2.0 | +| assets/branding/logo/solidcraft-lockup-horizontal.svg | SolidCraft contributors | assets/branding/logo/solidcraft-mark.svg beside assets/branding/logo/solidcraft-wordmark.svg, in the proportions of assets/branding/web/source/og.png; original artwork | MIT OR Apache-2.0 | +| assets/styles/ui/themes/onyx.json | SolidCraft contributors | original Onyx stone-grey palette, option overlays and semantic icon-role mapping; existing SolidCraft artwork is unchanged | MIT OR Apache-2.0 | +| docs/book/src/media/ui-tour/window.png | SolidCraft contributors | screenshot of SolidCraft 0.29.0 itself (`solidcraft --sample`, default dark theme, software renderer, 1280x800) with original numbered callouts (digits set in DejaVu Sans Bold), captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | +| docs/book/src/media/ui-tour/navigate.mp4 | SolidCraft contributors | original screen recording of the actual SolidCraft 0.29.0 English desktop UI (`--sample`, default dark theme, software renderer) orbiting, panning and zooming, with the original drawn pointer of examples/demo/overlay.py and labels set in DejaVu Sans Bold, captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | +| assets/locales/pending/sketch-tool-hints.json | carlymx | Original sketch tool hints and engine error translations | MIT OR Apache-2.0 | +| assets/locales/pending/primitive-pick-field-tips.json | SolidCraft contributors | Original primitive pick-field tooltip translations | MIT OR Apache-2.0 | +| assets/locales/pending/ribbon-panel-hover.json | SolidCraft contributors | Original ribbon panel menu preference labels and translations | MIT OR Apache-2.0 | +| docs/screenshots/box-insert-designer.gif | Shawn Marx | original recording made with BoxInsertDesigner's own Motion export (its three.js viewer) of its example game `examples/ccg-example` (https://github.com/ShawnMarx/BoxInsertDesigner): a card game box insert whose trays were built by SolidCraft through `solidcraft-cli`; the published card, board and box art in it is pixelated beyond recognition, and no logos or game names are shown (2.5× playback, 800 px wide) | MIT OR Apache-2.0 | +| docs/screenshots/box-insert-designer.mp4 | Shawn Marx | original recording made with BoxInsertDesigner's own Motion export (its three.js viewer) of its example game `examples/ccg-example` (https://github.com/ShawnMarx/BoxInsertDesigner): a card game box insert whose trays were built by SolidCraft through `solidcraft-cli`; the published card, board and box art in it is pixelated beyond recognition, and no logos or game names are shown (1280×720) | MIT OR Apache-2.0 | +| assets/locales/pending/agent-http-consent.json | SolidCraft contributors | Original endpoint-specific HTTP consent messages and translations | MIT OR Apache-2.0 | +| assets/locales/pending/ground-shadow-placement.json | SolidCraft contributors | Original ground-shadow placement preference messages and translations | MIT OR Apache-2.0 | +| docs/book/src/media/assemblies/components.mp4 | SolidCraft contributors | original screen recording of the actual SolidCraft 0.29.0 English desktop UI (default dark theme, software renderer) making components from two original hinge-leaf bodies, with the original drawn pointer of examples/demo/overlay.py and labels set in DejaVu Sans Bold, captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | +| docs/book/src/media/assemblies/joint.mp4 | SolidCraft contributors | original screen recording of the actual SolidCraft 0.29.0 English desktop UI (default dark theme, software renderer) creating a revolute joint between two hinge leaves, with the original drawn pointer of examples/demo/overlay.py and labels set in DejaVu Sans Bold, captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | +| docs/book/src/media/assemblies/drag.mp4 | SolidCraft contributors | original screen recording of the actual SolidCraft 0.29.0 English desktop UI (default dark theme, software renderer) dragging a jointed hinge leaf, with the original drawn pointer of examples/demo/overlay.py and labels set in DejaVu Sans Bold, captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | +| docs/book/src/media/assemblies/drive.mp4 | SolidCraft contributors | original screen recording of the actual SolidCraft 0.29.0 English desktop UI (default dark theme, software renderer) driving a revolute joint between two hinge leaves, with the original drawn pointer of examples/demo/overlay.py and labels set in DejaVu Sans Bold, captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | +| docs/book/src/media/features/extrude.mp4 | SolidCraft contributors | original screen recording of the actual SolidCraft 0.29.0 English desktop UI (default dark theme, software renderer) extruding a sketch's profile, with the original drawn pointer of examples/demo/overlay.py and labels set in DejaVu Sans Bold, captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | +| docs/book/src/media/features/shell.mp4 | SolidCraft contributors | original screen recording of the actual SolidCraft 0.29.0 English desktop UI (default dark theme, software renderer) shelling a block, with the original drawn pointer of examples/demo/overlay.py and labels set in DejaVu Sans Bold, captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | +| docs/book/src/media/features/fillet.mp4 | SolidCraft contributors | original screen recording of the actual SolidCraft 0.29.0 English desktop UI (default dark theme, software renderer) filleting four edges, with the original drawn pointer of examples/demo/overlay.py and labels set in DejaVu Sans Bold, captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | +| docs/book/src/media/features/edit.mp4 | SolidCraft contributors | original screen recording of the actual SolidCraft 0.29.0 English desktop UI (default dark theme, software renderer) editing a feature from the timeline, with the original drawn pointer of examples/demo/overlay.py and labels set in DejaVu Sans Bold, captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | +| docs/book/src/media/features/hole.mp4 | SolidCraft contributors | original screen recording of the actual SolidCraft 0.29.0 English desktop UI (default dark theme, software renderer) placing a hole, with the original drawn pointer of examples/demo/overlay.py and labels set in DejaVu Sans Bold, captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | +| docs/book/src/media/features/pattern.mp4 | SolidCraft contributors | original screen recording of the actual SolidCraft 0.29.0 English desktop UI (default dark theme, software renderer) patterning a hole around an axis, with the original drawn pointer of examples/demo/overlay.py and labels set in DejaVu Sans Bold, captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | +| docs/book/src/media/parameters/dialog.png | SolidCraft contributors | screenshot of SolidCraft 0.29.0 itself (default dark theme, software renderer) showing the Parameters dialog, with original numbered callouts (digits set in DejaVu Sans Bold), captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | +| docs/book/src/media/files/menu.png | SolidCraft contributors | screenshot of SolidCraft 0.29.0 itself (`--sample`, default dark theme, software renderer) showing the File menu, with original numbered callouts (digits set in DejaVu Sans Bold), captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | +| docs/book/src/media/getting-started/start.png | SolidCraft contributors | screenshot of SolidCraft 0.29.0 itself (default dark theme, software renderer, 1280x800) showing the start page with its built-in sample thumbnails, with original numbered callouts (digits set in DejaVu Sans Bold), captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | +| docs/book/src/media/getting-started/sample.mp4 | SolidCraft contributors | original screen recording of the actual SolidCraft 0.29.0 English desktop UI (default dark theme, software renderer) opening the built-in Sample Plate from the start page, with the original drawn pointer of examples/demo/overlay.py and labels set in DejaVu Sans Bold, captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | +| docs/book/src/media/sheet-metal/base.mp4 | SolidCraft contributors | original screen recording of the actual SolidCraft 0.29.0 English desktop UI (default dark theme, software renderer) making a sheet metal base flange, with the original drawn pointer of examples/demo/overlay.py and labels set in DejaVu Sans Bold, captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | +| docs/book/src/media/sheet-metal/flange.mp4 | SolidCraft contributors | original screen recording of the actual SolidCraft 0.29.0 English desktop UI (default dark theme, software renderer) adding sheet metal edge flanges, with the original drawn pointer of examples/demo/overlay.py and labels set in DejaVu Sans Bold, captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | +| docs/book/src/media/sheet-metal/flat.mp4 | SolidCraft contributors | original screen recording of the actual SolidCraft 0.29.0 English desktop UI (default dark theme, software renderer) showing a sheet metal flat pattern, with the original drawn pointer of examples/demo/overlay.py and labels set in DejaVu Sans Bold, captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | +| docs/book/src/media/sketching/create.mp4 | SolidCraft contributors | original screen recording of the actual SolidCraft 0.29.0 English desktop UI (default dark theme, software renderer) starting a sketch on the Top plane, with the original drawn pointer of examples/demo/overlay.py and labels set in DejaVu Sans Bold, captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | +| docs/book/src/media/sketching/draw.mp4 | SolidCraft contributors | original screen recording of the actual SolidCraft 0.29.0 English desktop UI (default dark theme, software renderer) drawing a rectangle and a circle with typed values, with the original drawn pointer of examples/demo/overlay.py and labels set in DejaVu Sans Bold, captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | +| docs/book/src/media/sketching/dimension.mp4 | SolidCraft contributors | original screen recording of the actual SolidCraft 0.29.0 English desktop UI (default dark theme, software renderer) dimensioning a sketch until it is fully constrained, with the original drawn pointer of examples/demo/overlay.py and labels set in DejaVu Sans Bold, captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | +| docs/book/src/media/sketching/parts.png | SolidCraft contributors | screenshot of SolidCraft 0.29.0 itself (default dark theme, software renderer, 1280x800) showing a fully constrained sketch, with original numbered callouts (digits set in DejaVu Sans Bold), captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | +| docs/book/src/media/sketching/offset.mp4 | SolidCraft contributors | original screen recording of the actual SolidCraft 0.29.0 English desktop UI (default dark theme, software renderer) offsetting a sketch outline, with the original drawn pointer of examples/demo/overlay.py and labels set in DejaVu Sans Bold, captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | +| docs/book/src/media/sketching/trim.mp4 | SolidCraft contributors | original screen recording of the actual SolidCraft 0.29.0 English desktop UI (default dark theme, software renderer) trimming a notch in a sketch, with the original drawn pointer of examples/demo/overlay.py and labels set in DejaVu Sans Bold, captured with examples/demo/doc_shots.py | MIT OR Apache-2.0 | ## Code adapted from sibling projects @@ -811,10 +866,19 @@ in THIRD-PARTY-LICENSES.txt; no images or artwork from that project are copied. The glTF test files are built by the tests themselves (crates/io/src/gltf_in_tests.rs, crates/engine/src/tests/gltf_import.rs); no third-party models are committed. +## Geometry kernel crates + +| Crate | Used for | Licence | +|---|---|---| +| solidcore (https://github.com/tangency-labs/solidcore, pinned by rev in Cargo.toml) | the Rust port of NVIDIA's SMLib: the B-rep kernel behind crates/smlib | Apache-2.0 (its NOTICE credits NVIDIA's USD BRep) | + +Linked as a crate; no code from it is copied into SolidCraft. Its licence text and NOTICE go +into THIRD-PARTY-LICENSES.txt when `main` regenerates it. + ## FreeCAD and Rhino import library FreeCAD `.FCStd` and Rhino `.3dm` files are read with [cadmpeg](https://github.com/cadmpeg/cadmpeg) -0.6.3 (Apache-2.0), linked as the crates `cadmpeg-core`, `cadmpeg-ir`, `cadmpeg-registry`, +0.6.7 (Apache-2.0), linked as the crates `cadmpeg-core`, `cadmpeg-ir`, `cadmpeg-registry`, `cadmpeg-container`, `cadmpeg-codec-freecad`, `cadmpeg-codec-rhino` and `cadmpeg-codec-step` in native and browser builds (`crates/io/src/native_cad.rs`). Only those open-format codecs are built: no default features, so cadmpeg's codecs for commercial CAD formats and its ShapeManager/ACIS @@ -826,16 +890,16 @@ copied into SolidCraft. | SolidCraft file | Original contribution | Licence | |---|---|---| | crates/ui-egui/src/viewport.rs (`nearest_quarter_turn`, `axis_view_orbit`) | N3MI-DG's [PR #101](https://github.com/bherbruck/solidcraft/pull/101): [minimal TOP/BOTTOM turns](https://github.com/bherbruck/solidcraft/commit/c28e780f52490784ef5886f094b9d3f6d10c3e3f) and [drag-to-orbit](https://github.com/bherbruck/solidcraft/commit/f30b30be6ecc4e2e6544a851243137c01a354934), adapted to the axis gizmo | MIT OR Apache-2.0 | +| crates/smlib/src/core/offset.rs (`draft`: the tilted planes and `SmBrep::LocalOperation`, the tail of the capi's `draft_faces`) | ablasik's `draft` in `crates/smlib/src/ffi/rs_ops2.rs` on [ablasik/solidcraft `app/solidcore-backend-on-develop`](https://github.com/ablasik/solidcraft/blob/9c7e8e31565e1823f0591b58e2967351c32af13f/crates/smlib/src/ffi/rs_ops2.rs), adapted to `core::offset`'s errors and checks | MIT OR Apache-2.0 | ## Vendored third-party code | Directory | Source | Licence | Changes | |---|---|---|---| -| vendor/accesskit_macos | accesskit_macos 0.26.3, https://github.com/AccessKit/accesskit (The AccessKit contributors) | MIT OR Apache-2.0 | the subclassing adapter and its tests from 0.27.2: dropping the adapter keeps AppKit's key-value observers (vendor/README.md) | ## Vendored renderer compatibility fix -`vendor/egui-wgpu` is egui-wgpu 0.36.2 from https://github.com/emilk/egui +`vendor/egui-wgpu` is egui-wgpu 0.37.0 from https://github.com/emilk/egui (MIT OR Apache-2.0; both original licence texts are included). Rust sources and its original `egui.wgsl` shader are retained; no images or other artwork are copied. SolidCraft's narrow patch selects a safe 1x MSAA path on the chosen OpenGL adapter diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a88bddcde..f3cc9a22a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -88,6 +88,8 @@ The [architecture page](docs/architecture.md) has the layer table. The short ver - `crates/geom`: vectors, planes, meshes, measures. - `crates/sketch`: our own constraint solver, plus profile finding. +- `crates/dynamics`: multibody dynamics: rigid bodies, joint constraints, gravity and springs, + integrated in time (RFC #9719). It depends only on `geom`. - `crates/kernel`: the B-rep kernel boundary. It wraps [truck](https://github.com/ricosjp/truck), and it's the only crate allowed to touch truck. Fillets, chamfers, shell/offset, Delete Face, Split Face, STEP/IGES read and write, and face provenance are our own code here. Patched @@ -163,6 +165,18 @@ the most complete description of the house style. The reference for what the kernel builds is the kernel-cases ladder (`tests/kernel-cases/ladder/`, `cargo xtask kernel-cases --ladder`, [docs/kernel-ladder.md](docs/kernel-ladder.md)). + +**Kernel cases go to solidcore.** A case that checks a kernel operation (a boolean, a blend, a +shell, a sweep, an import's geometry) is a new entry in solidcore's corpus, +`crates/solidcore/tests/kernel_cases//` in +[tangency-labs/solidcore](https://github.com/tangency-labs/solidcore), with an answer in closed +form or exact. Draft it as a rig case here, export it with +`cargo xtask kernel-cases --area --export DIR`, add `DIR//.json` and its +`.bodies.json.gz` there, and delete the draft; or write the entry by hand as that folder's README +describes. `tests/kernel-cases/` takes no new cases: its `CASES` list only shrinks +(`cargo xtask lists`). App-level cases (what a command does, the UI, product rules) stay in +SolidCraft, as tests in their area's existing test file or UI scenarios. + The naming corpus checks persistent names: every name a corpus design stores still finds a face or an edge, and two builds name its faces and edges alike (`cargo test --profile ci -p solidcraft-cli --test naming_corpus`). @@ -460,6 +474,16 @@ the same area), first resolve the command registry and source conflicts, then ru The generator tests cover stable ordering and additions that leave existing lines unchanged. The initial switch to sorted rows is a one-time larger diff. +## Pictures in the user guide + +The user guide's screenshots and short clips (`docs/book/src/media/`) are captured from the real +app by `examples/demo/doc_shots.py`, one function per figure. Each run starts a fresh app with its +own settings, so your preferences never show. When a change makes a figure out of date, run +`python3 examples/demo/doc_shots.py ` (it needs Xvfb, ffmpeg, Pillow and a release +build) and commit the new file. A new figure is a new function there, an ATTRIBUTION row in +`attribution/pending/`, and a `