From 765e28a22e3a6830f0c963866eb877014fc9937c Mon Sep 17 00:00:00 2001 From: Fabio Lussi <198260595+itrycodinganditsbad@users.noreply.github.com> Date: Mon, 12 Oct 2026 05:06:06 +0200 Subject: [PATCH] docs(user): apply final review fixes Part 1: verified = latest release tag policy in docs/user/AGENTS.md; released-pages sentence in root AGENTS.md. Part 6: re-pad Linux table. Co-Authored-By: Claude Opus 5.5 --- AGENTS.md | 2 +- docs/user/AGENTS.md | 3 +-- docs/user/getting-started/install.md | 4 ++-- 3 files changed, 4 insertions(+), 5 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 23ca7a099..33a46b454 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -41,7 +41,7 @@ People trust DesignCraft with their layouts; a crash loses their work. **This ou `ROADMAP.md` (committed) is the one-page summary: stage, headline numbers, dimensions, languages, progress log. It follows craftrules' [`standards/progress-docs.md`](https://github.com/storytold/craftrules/blob/main/standards/progress-docs.md). Details: `docs/target-app-parity.md` (assessment), `docs/gaps.md` (ranked work list: pick from the top), `docs/roadmap.md` (milestones, current focus), `docs/parity-checklist.md` (presence checklist, `cargo xtask parity`), and the typography, file-format, UI, hardware and localization parity docs in `docs/`. When work lands, update the affected docs and their status lines, delete or shrink the closed gap, and add a progress-log line to ROADMAP.md. ## User docs -User docs live in `docs/user/` and are published at https://getartcraft.com/docs/designcraft. If a change alters something a user sees or does (menu or dialog labels, install, file formats, errors), update the matching page in `docs/user/` in the same PR, or add one. Rules: `docs/user/AGENTS.md`. +User docs live in `docs/user/` and are published at https://getartcraft.com/docs/designcraft. If a change alters something a user sees or does (menu or dialog labels, install, file formats, errors), update the matching page in `docs/user/` in the same PR, or add one. Rules: `docs/user/AGENTS.md`. Pages describe the latest release. For a change that is not released yet, write that it was added after and is not in a release yet, or update the page when the release ships. ## Contributor credits (About window) diff --git a/docs/user/AGENTS.md b/docs/user/AGENTS.md index 2edbd117c..f24b1cf6a 100644 --- a/docs/user/AGENTS.md +++ b/docs/user/AGENTS.md @@ -36,8 +36,7 @@ either. Write for an artist, not a developer. Only `key: value` and `key: [a, b]` lines work. Quote values that start with a quote or contain ` #`. -Set `verified` to the workspace `version` in the root `Cargo.toml` whenever you check a -page against the current code. +Set `verified` to the latest release (the newest release tag) after checking the page against that tag with `git show :`. Pages describe the latest release users download, not unreleased code on main. ## Folders diff --git a/docs/user/getting-started/install.md b/docs/user/getting-started/install.md index 1344fee7f..b5bcfca54 100644 --- a/docs/user/getting-started/install.md +++ b/docs/user/getting-started/install.md @@ -27,8 +27,8 @@ The app is signed and notarized. Pick one file from the release. Replace `x86_64` with `aarch64` on ARM. -| File | Notes | -|-------------------------------------------|----------------------------------------------------------| +| File | Notes | +|-----------------------------------------------|----------------------------------------------------------| | `designcraft--linux-x86_64.AppImage` | Runs anywhere. | | `designcraft--linux-x86_64.flatpak` | Sandboxed. Install with `flatpak install --user `. | | `designcraft--linux-x86_64.deb` | Debian and Ubuntu. |