Skip to content

DesignCraft: An open-source page and layout design editor written by scratch in pure Rust

docs(user): apply final review fixes

Fabio Lusside28587995ad
diff --git a/docs/user/faq/supported-systems.md b/docs/user/faq/supported-systems.md
index cd118b1b4..b6701ac7c 100644
--- a/docs/user/faq/supported-systems.md
+++ b/docs/user/faq/supported-systems.md
@@ -7,9 +7,9 @@ verified: 0.6.0
DesignCraft runs on Windows, macOS and Linux, and in a modern web browser. The release also has builds for FreeBSD.
-- **Windows 11**: x64, arm64 and x86 installers, plus portable zips.
+- **Windows 11**: x64 and arm64 installers, plus portable zips.
- **macOS**: one universal build for Apple silicon and Intel.
- **Linux**: x86_64 and aarch64 as AppImage, Flatpak, `.deb`, `.rpm` or tarball, and a RISC-V tarball.
-- **Web**: a static site you host yourself (`designcraft-web-<ver>.zip`). It runs on WebGPU and falls back to WebGL2. The web build has no control channel, and Save and Export download the file.
+- **Web**: a static site you host yourself (`designcraft-web-<version>.zip`). It runs on WebGPU and falls back to WebGL2. The web build has no control channel, and Save and Export download the file.
All files are on the [latest release](https://github.com/storytold/designcraft/releases/latest). See [Install DesignCraft](../getting-started/install.md) for steps.
diff --git a/docs/user/getting-started/install.md b/docs/user/getting-started/install.md
index 94d6e52ef..1344fee7f 100644
--- a/docs/user/getting-started/install.md
+++ b/docs/user/getting-started/install.md
@@ -5,20 +5,20 @@ order: 20
verified: 0.6.0
---
-Download the file for your system from the [latest release](https://github.com/storytold/designcraft/releases/latest) and install it. In the file names, `<ver>` stands for the version number, for example `0.6.0`. The release also has `SHA256SUMS.txt`, which lists a checksum for every file. The [DesignCraft page on getartcraft.com](https://getartcraft.com/apps/designcraft) links to the download as well.
+Download the file for your system from the [latest release](https://github.com/storytold/designcraft/releases/latest) and install it. In the file names, `<version>` stands for the version number, for example `0.6.0`. The release also has `SHA256SUMS.txt`, which lists a checksum for every file. The [DesignCraft page on getartcraft.com](https://getartcraft.com/apps/designcraft) links to the download as well.
## Windows 11
1. Open the [latest release](https://github.com/storytold/designcraft/releases/latest).
-2. Download `designcraft-<ver>-windows-x64.msi`. It fits most PCs (64-bit Intel and AMD).
+2. Download `designcraft-<version>-windows-x64.msi`. It fits most PCs (64-bit Intel and AMD).
3. Run the file and follow the installer.
4. Start **DesignCraft** from the Start menu.
-The release also has an `arm64` installer for ARM PCs such as Snapdragon, and an `x86` installer for 32-bit Windows. To run without installing, download `designcraft-<ver>-windows-x64-portable.zip` (or the `arm64` or `x86` version), unzip it and start the program inside. The installers and executables are code-signed.
+The release also has an `arm64` installer for ARM PCs such as Snapdragon. To run without installing, download `designcraft-<version>-windows-x64-portable.zip` (or the `arm64` version), unzip it and start the program inside. The installers and executables are code-signed.
## macOS
-1. Download `designcraft-<ver>-macos-universal.dmg`. It works on Apple silicon and Intel Macs.
+1. Download `designcraft-<version>-macos-universal.dmg`. It works on Apple silicon and Intel Macs.
2. Open it and drag DesignCraft to Applications.
The app is signed and notarized.
@@ -29,13 +29,13 @@ Pick one file from the release. Replace `x86_64` with `aarch64` on ARM.
| File | Notes |
|-------------------------------------------|----------------------------------------------------------|
-| `designcraft-<ver>-linux-x86_64.AppImage` | Runs anywhere. |
-| `designcraft-<ver>-linux-x86_64.flatpak` | Sandboxed. Install with `flatpak install --user <file>`. |
-| `designcraft-<ver>-linux-x86_64.deb` | Debian and Ubuntu. |
-| `designcraft-<ver>-linux-x86_64.rpm` | Fedora, RHEL and openSUSE. |
-| `designcraft-<ver>-linux-x86_64.tar.gz` | Unpack anywhere. |
+| `designcraft-<version>-linux-x86_64.AppImage` | Runs anywhere. |
+| `designcraft-<version>-linux-x86_64.flatpak` | Sandboxed. Install with `flatpak install --user <file>`. |
+| `designcraft-<version>-linux-x86_64.deb` | Debian and Ubuntu. |
+| `designcraft-<version>-linux-x86_64.rpm` | Fedora, RHEL and openSUSE. |
+| `designcraft-<version>-linux-x86_64.tar.gz` | Unpack anywhere. |
-For RISC-V there is only `designcraft-<ver>-linux-riscv64.tar.gz`. It needs glibc 2.39 or newer (Ubuntu 24.04 or newer). A FreeBSD build (`designcraft-<ver>-freebsd-x86_64.tar.gz`) is on the release page too.
+For RISC-V there is only `designcraft-<version>-linux-riscv64.tar.gz`. It needs glibc 2.39 or newer (Ubuntu 24.04 or newer). A FreeBSD build (`designcraft-<version>-freebsd-x86_64.tar.gz`) is on the release page too.
## Install with ArtCraft Launcher
diff --git a/docs/user/guides/create-a-document.md b/docs/user/guides/create-a-document.md
index 4e833d8d8..76b95ae56 100644
--- a/docs/user/guides/create-a-document.md
+++ b/docs/user/guides/create-a-document.md
@@ -7,6 +7,8 @@ verified: 0.6.0
Choose **File**, then **New Document…** (Ctrl+N), set the page size and margins, and click **OK**.
+Shortcuts on this page use Ctrl. On macOS, use Cmd instead of Ctrl.
+
## Steps
1. Open the **File** menu and choose **New Document…**. On the start screen you can click **New file** instead.
diff --git a/docs/user/guides/export-a-pdf.md b/docs/user/guides/export-a-pdf.md
index b2ea20494..938c5dfe2 100644
--- a/docs/user/guides/export-a-pdf.md
+++ b/docs/user/guides/export-a-pdf.md
@@ -7,6 +7,8 @@ verified: 0.6.0
Choose **File**, then **Export PDF…**, pick a **Preset**, click **OK** and name the file.
+Shortcuts on this page use Ctrl. On macOS, use Cmd instead of Ctrl.
+
## Steps
1. Open the **File** menu and choose **Export PDF…**.
diff --git a/docs/user/guides/open-a-file.md b/docs/user/guides/open-a-file.md
index e435d00ce..2c1568346 100644
--- a/docs/user/guides/open-a-file.md
+++ b/docs/user/guides/open-a-file.md
@@ -1,16 +1,18 @@
---
title: Open a DesignCraft or InDesign (IDML) file
-description: Open a .designcraft document or an InDesign Markup (.idml) file, and what to do about missing fonts and warnings.
+description: Open a .designcraft document or an InDesign Markup (.idml) file, and what to do about missing fonts and incomplete IDML packages.
order: 20
verified: 0.6.0
---
Choose **File**, then **Open…** (Ctrl+O), and pick a `.designcraft` or `.idml` file. The file opens as a new document.
+Shortcuts on this page use Ctrl. On macOS, use Cmd instead of Ctrl.
+
## Steps
1. Open the **File** menu and choose **Open…**. On the start screen you can click **Open** instead.
-2. In the file dialog, pick a file. The dialog lists two kinds: **DesignCraft** (`.designcraft`) and **InDesign Markup (IDML)** (`.idml`).
+2. In the file dialog, pick a file. The dialog lists **DesignCraft or IDML** (both, listed first), **DesignCraft** (`.designcraft`) and **InDesign Markup (IDML)** (`.idml`).
3. Confirm the dialog. The document opens as a new document.
## What the Open dialog accepts
@@ -25,7 +27,7 @@ Text that uses a font DesignCraft cannot find is highlighted in pink. This is th
## Import warnings
-If an IDML package is missing some of its parts, DesignCraft still opens what it can and shows an alert titled **Import Warnings** that names the missing parts. Your other open documents stay as they are. Click **OK** to close the alert.
+If an IDML package is missing some of its parts, 0.6.0 may not open it. Opening such files with an **Import Warnings** alert that names the missing parts was added after 0.6.0 and is not in a release yet.
## Save it again
diff --git a/docs/user/guides/place-images-and-text.md b/docs/user/guides/place-images-and-text.md
index b10601f5c..3ac9b2382 100644
--- a/docs/user/guides/place-images-and-text.md
+++ b/docs/user/guides/place-images-and-text.md
@@ -6,6 +6,9 @@ verified: 0.6.0
---
Choose **File**, then **Place…** (Ctrl+D), pick a file, and DesignCraft puts it into your document.
+
+Shortcuts on this page use Ctrl. On macOS, use Cmd instead of Ctrl.
+
## Steps
1. Open the **File** menu and choose **Place…**.
diff --git a/docs/user/troubleshooting/app-closes-at-start.md b/docs/user/troubleshooting/app-closes-at-start.md
index 791465163..b8908fe6c 100644
--- a/docs/user/troubleshooting/app-closes-at-start.md
+++ b/docs/user/troubleshooting/app-closes-at-start.md
@@ -15,11 +15,11 @@ If DesignCraft flashes a spinner and closes, update to the [latest release](http
## Fix
-1. Install the [latest release](https://github.com/storytold/designcraft/releases/latest). DesignCraft remembers a start that never showed a window and tries the next graphics backend on the following start. On Windows the order is DirectX 12, Vulkan, then OpenGL, and the status bar says when it switches. A reporter who could not start 0.5.0 on Windows 11 Enterprise wrote that 0.6.0 launched without trouble.
-2. If it still closes, set an environment variable named `WGPU_BACKEND` with the value `dx12`. Start DesignCraft from a shell where it is set, or add it in Windows settings for your account. People who hit this crash with an AMD graphics driver reported that DesignCraft starts with `WGPU_BACKEND=dx12`.
+1. Install the [latest release](https://github.com/storytold/designcraft/releases/latest). DesignCraft remembers a start that never showed a window and tries the next graphics backend on the following start. On Windows the order is DirectX 12, Vulkan, then OpenGL, and the status bar says when it switches. A reporter who could not start 0.5.0 on Windows 11 Enterprise wrote that 0.6.0 launched without trouble ([issue #273](https://github.com/storytold/designcraft/issues/273)).
+2. If it still closes, set an environment variable named `WGPU_BACKEND` with the value `dx12`. Start DesignCraft from a shell where it is set, or add it in Windows settings for your account. People who hit this crash with an AMD graphics driver reported that DesignCraft starts with `WGPU_BACKEND=dx12`. `dx12` also avoids Intel's Vulkan driver (`igvk64.dll`), which crashed in [issue #192](https://github.com/storytold/designcraft/issues/192).
3. Start DesignCraft again.
-Setting `WGPU_BACKEND` also turns off the automatic fallback. Other accepted values are `vulkan` and `gl`, and a comma-separated list lets the graphics library choose among them.
+Setting `WGPU_BACKEND` also turns off the automatic fallback. Other accepted values are `vulkan` and `gl`, and a comma-separated list lets the graphics library choose among them. Do not pick `vulkan` on Intel graphics or `gl` on AMD graphics: those are the drivers in the crash reports.
## Why this happens