aleleba/designcraft
1
0
Fork 0
mirror of https://github.com/storytold/designcraft.git synced 2026-10-27 11:46:51 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs(user): apply final review fixes

Browse Source 
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 <noreply@anthropic.com>
This commit is contained in:
Fabio Lussi
2026-10-12 05:06:06 +02:00
co-authored by Claude Opus 5.5
parent de28587995
commit 765e28a22e
3 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+1 -1
View File
@@ -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 <version> and is not in a release yet, or update the page when the release ships.
## Contributor credits (About window)
docs/user/AGENTS.md
+1 -2
View File
@@ -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 <tag>:<path>`. Pages describe the latest release users download, not unreleased code on main.
## Folders
docs/user/getting-started/install.md
+2 -2
View File
@@ -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-<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. |