diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 8ec0c2e9..5e7b7fa2 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: true contact_links: - name: Questions and chat - url: https://discord.gg/FtU4NQNVDH + url: https://solidcraft.io/discord about: Ask questions and talk with users and contributors on the SolidCraft Discord. diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 604c3fef..d4c9a426 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -1,5 +1,5 @@ -# The documentation site on GitHub Pages: the book (docs/book) at /solidcraft/ and the web app -# at /solidcraft/app/. Needs Settings → Pages → Source = GitHub Actions; skipped while the +# 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 # repository is private. name: Pages @@ -56,7 +56,7 @@ jobs: run: cargo xtask book - name: Build the web app working-directory: apps/solidcraft-web - run: trunk build --release --public-url /solidcraft/app/ + run: trunk build --release --public-url ./ - name: Test the web app offline and across an update (headless Chrome) run: cargo xtask web-offline-test --site dist/web - name: Assemble the site diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7e9fcc8c..d0c985cb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,7 @@ Help is welcome, whether that's a one-line fix or owning a whole area. This page build it, how the code is laid out, the few rules that aren't negotiable, and where help is needed most. -Questions, ideas or want to say what you're working on? Join the [Discord](https://discord.gg/FtU4NQNVDH). +Questions, ideas or want to say what you're working on? Join the [Discord](https://solidcraft.io/discord). ## Get it running (about 10 minutes on a fast machine) @@ -18,7 +18,7 @@ You need stable Rust 1.95 or newer (required by egui/eframe 0.36). For the web build you also need `rustup target add wasm32-unknown-unknown` and [`trunk`](https://trunkrs.dev). ```sh -git clone https://github.com/bherbruck/solidcraft && cd solidcraft +git clone https://github.com/tangency-labs/solidcraft && cd solidcraft cargo run --release -p solidcraft -- --sample # desktop app with a sample part cargo xtask test # unit, engine and UI-scenario tests cargo xtask ci # everything a PR must pass (see below) @@ -247,11 +247,11 @@ and a fresh CI run: ## Sending a change -1. Work is tracked in [GitHub issues](https://github.com/bherbruck/solidcraft/issues), labelled +1. Work is tracked in [GitHub issues](https://github.com/tangency-labs/solidcraft/issues), labelled by area (`area:kernel`, `area:sketch`, `area:doc`, `area:ui`, `area:infra`). For anything bigger than a bug fix that has no issue yet, open one first. **Claim the issue with a draft PR** before you start, so two people don't build the same thing: - - Check nobody has it: `gh pr list -R bherbruck/solidcraft --state open --search "#N"`. + - Check nobody has it: `gh pr list -R tangency-labs/solidcraft --state open --search "#N"`. - Branch from the latest `main`, commit `git commit --allow-empty -m "claim: #N"`, push, and open a **draft** PR titled ` (#N)`, e.g. `Fillet: variable radius along a chain (#123)`. - **The lowest-numbered open PR for an issue wins.** If yours lost, close it (or offer to help @@ -299,10 +299,10 @@ long as the change meets the rules above. ## Where help is wanted most -**Kernel speed (slow fillets, booleans, STEP):** please don't rewrite the current kernel code for speed; it is being replaced by [solidcore](https://github.com/bherbruck/solidcore) ([progress](https://bherbruck.github.io/solidcore/)). Report slow cases with a file under the `kernel-perf` label, and put kernel effort into solidcore instead. See [#1597](https://github.com/bherbruck/solidcraft/issues/1597). +**Kernel speed (slow fillets, booleans, STEP):** please don't rewrite the current kernel code for speed; it is being replaced by [solidcore](https://github.com/bherbruck/solidcore) ([progress](https://bherbruck.github.io/solidcore/)). Report slow cases with a file under the `kernel-perf` label, and put kernel effort into solidcore instead. See [#1597](https://github.com/tangency-labs/solidcraft/issues/1597). -See the [`help wanted`](https://github.com/bherbruck/solidcraft/labels/help%20wanted) and -[`good first issue`](https://github.com/bherbruck/solidcraft/labels/good%20first%20issue) labels. +See the [`help wanted`](https://github.com/tangency-labs/solidcraft/labels/help%20wanted) and +[`good first issue`](https://github.com/tangency-labs/solidcraft/labels/good%20first%20issue) labels. In order of how much they'd help users: 1. **Fillet and blend robustness.** Fillets are our own code (truck has no fillet operation). diff --git a/README.md b/README.md index 7e972e42..8071a783 100644 --- a/README.md +++ b/README.md @@ -23,25 +23,25 @@

Website · - Download · - Try it in the browser · - Documentation · - Discord · + Download · + Try it in the browser · + Documentation · + Discord · SolidCore

- CI - Latest release - Downloads - Licence - Discord - Stars + CI + Latest release + Downloads + Licence + Discord + Stars

![SolidCraft 0.8: model a Raspberry Pi 4 case from an empty design: a sketch dimensioned with parameters, extrude, fillets and shell, a rim rounded in one pick, standoffs patterned on the board's mounting holes, port cut-outs, vent slots, "Pi 4" engraved in a font, a PETG material with its mass in Properties, and a height change in Parameters](docs/screenshots/demo-0.8.gif) -*A Raspberry Pi 4 case from an empty design: a sketch dimensioned with the board's parameters, extrude, fillet, shell, the rim rounded in one pick, an M2.5 standoff patterned on the 58 × 49 mm hole rectangle, port cut-outs, vent slots, "Pi 4" engraved in DejaVu Sans Bold and a PETG material defined in the design, with its mass in Properties, then height 24 → 32 mm in Parameters and it all rebuilds. 9× playback. [Full video](https://github.com/bherbruck/solidcraft/raw/refs/heads/main/docs/screenshots/demo-0.8.mp4), recorded with the [demo script](examples/demo/record_ui.sh).* +*A Raspberry Pi 4 case from an empty design: a sketch dimensioned with the board's parameters, extrude, fillet, shell, the rim rounded in one pick, an M2.5 standoff patterned on the 58 × 49 mm hole rectangle, port cut-outs, vent slots, "Pi 4" engraved in DejaVu Sans Bold and a PETG material defined in the design, with its mass in Properties, then height 24 → 32 mm in Parameters and it all rebuilds. 9× playback. [Full video](https://github.com/tangency-labs/solidcraft/raw/refs/heads/main/docs/screenshots/demo-0.8.mp4), recorded with the [demo script](examples/demo/record_ui.sh).* ## Download @@ -54,7 +54,7 @@ (Apple silicon and Intel). - **Linux:** download the [AppImage][linux-appimage], allow it to run as a program and open it. Or install the [.deb][linux-deb] (Ubuntu, Debian, Mint) or [.rpm][linux-rpm] (Fedora, - openSUSE), or use [Flatpak](https://bherbruck.github.io/solidcraft/guide/getting-started.html#linux-flatpak). + openSUSE), or use [Flatpak](https://docs.solidcraft.io/guide/getting-started.html#linux-flatpak). With Snap: `sudo snap install solidcraft` ([Snap Store][snap-store], or the [.snap file][linux-snap]). For ARM64: [AppImage][linux-arm64-appimage], [.deb][linux-arm64-deb], [.rpm][linux-arm64-rpm]. - **Web:** [try it in your browser][web-app], no install. @@ -62,41 +62,41 @@ The downloads aren't signed yet. On Windows, if SmartScreen warns you, choose **More info**, then **Run anyway**. On macOS, the first time, right-click SolidCraft in Applications and choose **Open**. -Older versions, checksums and other formats are on the [releases page](https://github.com/bherbruck/solidcraft/releases). +Older versions, checksums and other formats are on the [releases page](https://github.com/tangency-labs/solidcraft/releases). Install details, upgrading from earlier builds and building from source are in -[Getting started](https://bherbruck.github.io/solidcraft/guide/getting-started.html). +[Getting started](https://docs.solidcraft.io/guide/getting-started.html). [badge-windows]: https://img.shields.io/badge/Windows-Download-0078D6?style=for-the-badge&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0id2hpdGUiPjxwYXRoIGQ9Ik0yIDJoOS41djkuNUgyek0xMi41IDJIMjJ2OS41aC05LjV6TTIgMTIuNWg5LjVWMjJIMnpNMTIuNSAxMi41SDIyVjIyaC05LjV6Ii8%2BPC9zdmc%2B [badge-macos]: https://img.shields.io/badge/macOS-Download-333333?style=for-the-badge&logo=apple&logoColor=white [badge-linux]: https://img.shields.io/badge/Linux-AppImage-E95420?style=for-the-badge&logo=linux&logoColor=white [badge-snap]: https://img.shields.io/badge/Snap-Snap_Store-82BEA0?style=for-the-badge&logo=snapcraft&logoColor=white [badge-web]: https://img.shields.io/badge/Web-Try_in_browser-2EA44F?style=for-the-badge&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0ibm9uZSIgc3Ryb2tlPSJ3aGl0ZSIgc3Ryb2tlLXdpZHRoPSIyIj48Y2lyY2xlIGN4PSIxMiIgY3k9IjEyIiByPSIxMCIvPjxwYXRoIGQ9Ik0yIDEyaDIwTTEyIDJhMTUgMTUgMCAwIDEgMCAyME0xMiAyYTE1IDE1IDAgMCAwIDAgMjAiLz48L3N2Zz4%3D -[windows-msi]: https://github.com/bherbruck/solidcraft/releases/latest/download/solidcraft-windows-x64.msi -[windows-arm64-msi]: https://github.com/bherbruck/solidcraft/releases/latest/download/solidcraft-windows-arm64.msi -[windows-x86-msi]: https://github.com/bherbruck/solidcraft/releases/latest/download/solidcraft-windows-x86.msi -[windows-portable]: https://github.com/bherbruck/solidcraft/releases/latest/download/solidcraft-windows-x64-portable.zip -[macos-dmg]: https://github.com/bherbruck/solidcraft/releases/latest/download/solidcraft-macos-universal.dmg -[linux-appimage]: https://github.com/bherbruck/solidcraft/releases/latest/download/solidcraft-linux-x86_64.AppImage -[linux-deb]: https://github.com/bherbruck/solidcraft/releases/latest/download/solidcraft-linux-x86_64.deb -[linux-rpm]: https://github.com/bherbruck/solidcraft/releases/latest/download/solidcraft-linux-x86_64.rpm -[linux-arm64-appimage]: https://github.com/bherbruck/solidcraft/releases/latest/download/solidcraft-linux-aarch64.AppImage -[linux-arm64-deb]: https://github.com/bherbruck/solidcraft/releases/latest/download/solidcraft-linux-aarch64.deb -[linux-arm64-rpm]: https://github.com/bherbruck/solidcraft/releases/latest/download/solidcraft-linux-aarch64.rpm -[linux-snap]: https://github.com/bherbruck/solidcraft/releases/latest/download/solidcraft-linux-x86_64.snap +[windows-msi]: https://github.com/tangency-labs/solidcraft/releases/latest/download/solidcraft-windows-x64.msi +[windows-arm64-msi]: https://github.com/tangency-labs/solidcraft/releases/latest/download/solidcraft-windows-arm64.msi +[windows-x86-msi]: https://github.com/tangency-labs/solidcraft/releases/latest/download/solidcraft-windows-x86.msi +[windows-portable]: https://github.com/tangency-labs/solidcraft/releases/latest/download/solidcraft-windows-x64-portable.zip +[macos-dmg]: https://github.com/tangency-labs/solidcraft/releases/latest/download/solidcraft-macos-universal.dmg +[linux-appimage]: https://github.com/tangency-labs/solidcraft/releases/latest/download/solidcraft-linux-x86_64.AppImage +[linux-deb]: https://github.com/tangency-labs/solidcraft/releases/latest/download/solidcraft-linux-x86_64.deb +[linux-rpm]: https://github.com/tangency-labs/solidcraft/releases/latest/download/solidcraft-linux-x86_64.rpm +[linux-arm64-appimage]: https://github.com/tangency-labs/solidcraft/releases/latest/download/solidcraft-linux-aarch64.AppImage +[linux-arm64-deb]: https://github.com/tangency-labs/solidcraft/releases/latest/download/solidcraft-linux-aarch64.deb +[linux-arm64-rpm]: https://github.com/tangency-labs/solidcraft/releases/latest/download/solidcraft-linux-aarch64.rpm +[linux-snap]: https://github.com/tangency-labs/solidcraft/releases/latest/download/solidcraft-linux-x86_64.snap [snap-store]: https://snapcraft.io/solidcraft -[web-app]: https://bherbruck.github.io/solidcraft/app/ +[web-app]: https://solidcraft.ai/ -**Documentation:** the [SolidCraft book](https://bherbruck.github.io/solidcraft/) (user guide, +**Documentation:** the [SolidCraft book](https://docs.solidcraft.io/) (user guide, developer guide and command reference; sources in [docs/book](docs/book)). -**Community:** chat with users and contributors on [Discord](https://discord.gg/FtU4NQNVDH). +**Community:** chat with users and contributors on [Discord](https://solidcraft.io/discord). **Status: early but usable for simple parts.** 75 of 76 public reference parts match their analytic or FreeCAD-computed volume, area, centre of mass and bounding box ([docs/oracle.md](docs/oracle.md)); the other is a tracked bug. These checks do not establish complete geometric or workflow equivalence. The commands SolidCraft has are listed by area in [docs/features.md](docs/features.md); status and plans are in [ROADMAP.md](ROADMAP.md). -Open work and known bugs are in [GitHub issues](https://github.com/bherbruck/solidcraft/issues), +Open work and known bugs are in [GitHub issues](https://github.com/tangency-labs/solidcraft/issues), and help is welcome: see [CONTRIBUTING.md](CONTRIBUTING.md). ## Built with SolidCraft @@ -106,7 +106,7 @@ and help is welcome: see [CONTRIBUTING.md](CONTRIBUTING.md). *SELENE, a scientific rover built entirely through SolidCraft's MCP server by [@0xlillith](https://github.com/0xlillith/solidcraft-rover): 3,323 editable timeline steps that rebuild with no errors, replayed here at 2× speed. -[Full video](https://github.com/bherbruck/solidcraft/raw/refs/heads/main/docs/screenshots/rover-build.mp4) +[Full video](https://github.com/tangency-labs/solidcraft/raw/refs/heads/main/docs/screenshots/rover-build.mp4) · [download the editable model](https://github.com/0xlillith/solidcraft-rover/releases/tag/v1.0.0).* ## What works diff --git a/apps/solidcraft-web/index.html b/apps/solidcraft-web/index.html index aa66df9a..2157e05e 100644 --- a/apps/solidcraft-web/index.html +++ b/apps/solidcraft-web/index.html @@ -9,15 +9,15 @@ - - + + - + diff --git a/docs/book/book.toml b/docs/book/book.toml index a306debd..00fd80a7 100644 --- a/docs/book/book.toml +++ b/docs/book/book.toml @@ -10,9 +10,9 @@ build-dir = "../../target/book" create-missing = false [output.html] -git-repository-url = "https://github.com/bherbruck/solidcraft" -edit-url-template = "https://github.com/bherbruck/solidcraft/edit/main/docs/book/{path}" -site-url = "/solidcraft/" +git-repository-url = "https://github.com/tangency-labs/solidcraft" +edit-url-template = "https://github.com/tangency-labs/solidcraft/edit/main/docs/book/{path}" +site-url = "/" no-section-label = false [output.html.search] @@ -23,7 +23,7 @@ enable = true # links; these send them to the right place. "/dev/mcp.html" = "../guide/mcp.html" "/dev/docs/oracle.html" = "../oracle.html" -"/dev/README.html" = "https://github.com/bherbruck/solidcraft/blob/main/README.md" -"/dev/ATTRIBUTION.html" = "https://github.com/bherbruck/solidcraft/blob/main/ATTRIBUTION.md" -"/dev/AGENTS.html" = "https://github.com/bherbruck/solidcraft/blob/main/AGENTS.md" -"/dev/ROADMAP.html" = "https://github.com/bherbruck/solidcraft/blob/main/ROADMAP.md" +"/dev/README.html" = "https://github.com/tangency-labs/solidcraft/blob/main/README.md" +"/dev/ATTRIBUTION.html" = "https://github.com/tangency-labs/solidcraft/blob/main/ATTRIBUTION.md" +"/dev/AGENTS.html" = "https://github.com/tangency-labs/solidcraft/blob/main/AGENTS.md" +"/dev/ROADMAP.html" = "https://github.com/tangency-labs/solidcraft/blob/main/ROADMAP.md" diff --git a/docs/book/theme/head.hbs b/docs/book/theme/head.hbs index 87857aa9..05ffee23 100644 --- a/docs/book/theme/head.hbs +++ b/docs/book/theme/head.hbs @@ -3,13 +3,13 @@ - - + + - +