From d3690e76c4fde13dc13ff046f7f114c566b659b3 Mon Sep 17 00:00:00 2001 From: Fabio Lussi <198260595+itrycodinganditsbad@users.noreply.github.com> Date: Mon, 12 Oct 2026 05:06:01 +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: blank line in install. Co-Authored-By: Claude Opus 5.5 --- AGENTS.md | 2 ++ docs/user/AGENTS.md | 3 +-- docs/user/getting-started/install.md | 1 + 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index f2082f7a5..e2662e69e 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -99,6 +99,8 @@ of it. Full standard: `../craftrules/standards/never-crash.md` User docs live in `docs/user/` and are published at https://getartcraft.com/docs/lightcraft. If a change alters something a user sees or does (menu or panel labels, import, export, install, errors), update the matching page in `docs/user/` in the same commit, or add one. Rules: `docs/user/AGENTS.md`; the checker runs in `docs-check.yml`. +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. ## Running and looking at the app - `cargo run --release -p lightcraft -- --control 7980` opens the desktop app with the JSON-lines control server (see `docs/control-protocol.md`). diff --git a/docs/user/AGENTS.md b/docs/user/AGENTS.md index b9f904814..3ac4f0e20 100644 --- a/docs/user/AGENTS.md +++ b/docs/user/AGENTS.md @@ -35,8 +35,7 @@ things up for either. Write for a photographer, 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 `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 f53bb7de0..689d2c876 100644 --- a/docs/user/getting-started/install.md +++ b/docs/user/getting-started/install.md @@ -15,6 +15,7 @@ Download the file for your system from the [latest release](https://github.com/s 4. At the end, choose the option to start LightCraft. For a Snapdragon or other Arm PC, download `lightcraft--windows-arm64.msi` instead. + To run it without installing, download `lightcraft--windows-x64-portable.zip`. A portable build for `arm64` is on the release page too. ## macOS