Merge pull request #1074 from aiongg/docs-tidy

docs: tidy AGENTS.md, CI comment and attribution
This commit is contained in:
Dylan M. Taylor authored and GitHub committed 2026-10-31 01:07:01 -04:00
commit e13bc89e89
3 files changed
+4 -9

No files matched your search

+1 -1
View File
@@ -23,7 +23,7 @@ jobs:
strategy:
fail-fast: false
matrix:
# No macOS on PRs or main (craftrules release/cut-a-release.md): the org's 5 macOS slots
# No macOS on PRs or main: the org's 5 macOS slots
# are kept for release builds, and release.yml builds and checks macOS.
os: [ubuntu-latest, windows-latest]
steps:
+2 -7
View File
@@ -13,9 +13,6 @@ Suite**. Machine names stay lowercase: crates and binaries (`artcraft-launcher`,
`artcraft-launcher-*`), file names, and the app id `ai.storyteller.artcraft-launcher`. Note the
GitHub repo is `storytold/craft-launcher`, while every file and package is `artcraft-launcher-*`.
Standards and learnings shared across the Craft apps live in `../craftrules` (read its
`README.md` and `AGENTS.md`). Contribute reusable learnings there, never code.
## 1. Workspace map
```text
@@ -45,8 +42,7 @@ the apps opens windows, tray icons or notifications.
### Never crash (outranks feature work)
A bad network response, a malformed release, a half-downloaded file, a full disk or a corrupt
settings file must produce an error the user can act on, never a panic. Shared standard:
`../craftrules/standards/never-crash.md`.
settings file must produce an error the user can act on, never a panic.
- **Non-test code never panics.** No `unwrap()`, `expect()`, `panic!`, `unreachable!`, `todo!` or
`unimplemented!`. Return the crate's error type and propagate with `?`.
@@ -144,8 +140,7 @@ packaging/linux/AppRun` and `actionlint`.
The version lives only in `[workspace.package] version` in the root `Cargo.toml`
(`cargo xtask version`, `cargo xtask version set X.Y.Z[-pre]`). Pushing to the `release` branch runs
`.github/workflows/release.yml`, which builds every platform and creates the draft GitHub Release
**ArtCraft Launcher v<version>** with `SHA256SUMS.txt`. The canonical recipe is
`../craftrules/release/playbook.md`; cutting a release is `../craftrules/release/cut-a-release.md`.
**ArtCraft Launcher v<version>** with `SHA256SUMS.txt`.
Release assets (keep these names exact; the launcher's own self-update and the README rely on them):
+1 -1
View File
@@ -55,5 +55,5 @@ licensed like those apps. Refresh them from the source path, never redraw them.
| Path | Title | Author | Source | License |
|---|---|---|---|---|
| `docs/brand/` (all files) | ArtCraft name, wordmark and mark | ArtCraft Team | getartcraft.com (via `craftrules/assets/brand/`) | Not open source; trademarks of the ArtCraft Team, [`docs/brand/LICENSE-brand.txt`](docs/brand/LICENSE-brand.txt) |
| `docs/brand/` (all files) | ArtCraft name, wordmark and mark | ArtCraft Team | getartcraft.com | Not open source; trademarks of the ArtCraft Team, [`docs/brand/LICENSE-brand.txt`](docs/brand/LICENSE-brand.txt) |
| README app icons (linked, not copied) | Each Craft app's 64 px icon | ArtCraft Team and each app's contributors | `raw.githubusercontent.com/storytold/<app>/main/assets/app-icon/hicolor/64x64/apps/ai.storyteller.<app>.png` | MIT OR Apache-2.0 (each app's license) |