mirror of
https://github.com/storytold/photocraft.git
synced 2026-10-25 10:27:07 -06:00
c6fd71241d
* docs: add user docs for PhotoCraft Adds docs/user/ (published at getartcraft.com/docs/photocraft), the docs check and publish workflows (copied from craft-launcher), and a User docs rule in AGENTS.md. Checker: 0 error(s), 0 warning(s). Source notes per page: - index.md: README (intro, status, Crafting Apps table), website crafting-apps.ts photocraft entry, links.rs (Discord, issues), menus.rs (Help > Report an Issue). - getting-started/index.md: menus.rs and menu_catalog.rs labels, panels.rs (Layers, Properties, History), dialogs.rs (Create button). - getting-started/install.md: README Downloads and Get started sections, gh release view v0.7.0 asset list, craft-launcher catalog.rs (lists PhotoCraft). - guides/open-and-save-files.md: apps/photocraft/src/services.rs (open and save filters), README Formats and PSD sections, docs/file-format-parity.md. - guides/adjust-colors-with-adjustment-layers.md: menu_catalog.rs, panels.rs (footer button, adjustment list), lib.rs (Properties shows new layer). - guides/select-and-mask.md: menu_catalog.rs Select and Layer Mask menus, state.rs tool names, retouch_ui.rs (Select Subject button and message). - guides/add-and-style-text.md: state.rs (Horizontal Type Tool, T), type_tool.rs, menu_catalog.rs Layer Style and Type menus, dialogs.rs. - guides/export-an-image.md: export_dialog.rs (labels, formats, options). - troubleshooting/taskbar-turns-black.md: issues 3550, 3864, 3430, 3144, PR 3308 (git: not an ancestor of v0.7.0), prefs_ui.rs (System title bar). - troubleshooting/text-moves-when-editing.md: issues 3795, 1317, PR 3819 (open). - troubleshooting/get-help.md: menus.rs, links.rs, gpu_status.rs (System Info content). - faq/*: README (status, license badge, offline, formats), LICENSE-MIT and LICENSE-APACHE, docs/file-format-parity.md. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * 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 4 items 1-9: remove x86 row and TGA resolution, formats, new photocraft-does-not-start page, mask label, taskbar workaround, wording, Affinity read-only, index. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs(user): use the standard section title Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs(user): describe PhotoCraft 0.7.0 startup behaviour Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs(user): tighten PhotoCraft startup wording Drop the unsourced "slower" claim for CPU mode and give the exact Preferences path on Windows and macOS. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs: pin the docs checker to a commit and its SHA-256 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs: drop the docs workflows until the checker is on artcraft-services main Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs: re-verify against 0.8.2 - taskbar and PSD text pages: both fixes ship in 0.8.2; tell users to update and drop the "not in a release yet" wording and workarounds - does not start: 0.8.2 fixes the Intel Iris Pro/Monterey Device(Lost) case; OpenCore Legacy Patcher Macs still have no fix - install: Windows 10 or later, 32-bit Windows builds, RISC-V deb/rpm, Wayland paste and XWayland notice - open and save: Krita and Paint.NET filters, Krita/PCX/FITS formats, save progress, JPEG/WebP encoding kept on Save - export: TGA Resolution, multi-layer Export As and Quick Export - text: Shift-click starts new text over existing type - CLAUDE.md is now a regular file pointing to AGENTS.md - verified: 0.8.2 on every page Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Drop the root AGENTS.md docs rule; keep the PR to docs/user/ Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs(user): drop the stale missing-tools count from the Photoshop FAQ Re-verified the page against v0.9.0. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Co-authored-by: Fabio Lussi <198260595+itrycodinganditsbad@users.noreply.github.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
61 lines
2.8 KiB
Markdown
61 lines
2.8 KiB
Markdown
# User docs: rules for agents and contributors
|
||
|
||
Everything in this folder (except this file, CLAUDE.md and README.md) is published at
|
||
https://getartcraft.com/docs/photocraft. The file path is the URL:
|
||
`troubleshooting/taskbar-turns-black.md` → `/docs/photocraft/troubleshooting/taskbar-turns-black`.
|
||
Renaming a file breaks links, so add the old path to `redirect_from` when you rename.
|
||
|
||
## Who reads this
|
||
|
||
Artists using PhotoCraft, Discord mods answering them, and AI assistants looking things up for
|
||
either. Write for an artist, not a developer.
|
||
|
||
## Page rules
|
||
|
||
- One question or problem per page. Lead with the answer or the fix in the first two lines.
|
||
- Plain words, short sentences, numbered steps for anything the reader does.
|
||
- Start the body at `##`. The page title comes from frontmatter.
|
||
- Link to other pages instead of repeating them. Use relative links to the `.md` file:
|
||
`[Install PhotoCraft](../getting-started/install.md)`.
|
||
- No marketing copy, no "simply", no claims you have not checked in the code or a release.
|
||
- Call the product "PhotoCraft", as the app, its downloads and getartcraft.com do.
|
||
- Name UI labels exactly as the app shows them, in **bold**. Menu paths read `File › Open…`.
|
||
- Troubleshooting pages: `## Symptoms`, `## Fix`, `## Why this happens` (optional),
|
||
`## Still stuck?` (link the issue tracker or Discord).
|
||
|
||
## Frontmatter
|
||
|
||
---
|
||
title: Export an image as PNG or JPEG
|
||
description: One sentence for search results, link previews and AI summaries.
|
||
order: 10 # optional, sorts within the folder (lower first)
|
||
verified: 0.7.0 # optional, app version you last checked this page against
|
||
redirect_from: [old/path] # optional, old URLs (relative to /docs/photocraft)
|
||
---
|
||
|
||
Only `key: value` and `key: [a, b]` lines work. Quote values that start with a quote or contain ` #`.
|
||
|
||
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
|
||
|
||
- `getting-started/` install and first run
|
||
- `guides/` how to do one thing
|
||
- `troubleshooting/` symptom → fix
|
||
- `faq/` short answers
|
||
- `reference/` lists and settings
|
||
|
||
A folder's `index.md` names the folder in the sidebar. Files or folders starting with `_` are
|
||
drafts and are not published.
|
||
|
||
## Check before you push
|
||
|
||
node <path to your artcraft-services checkout>/frontend/apps/artcraft-website-next/scripts/docs/core.mjs docs/user
|
||
|
||
The checker lives in storytold/artcraft-services. A CI check will be added once it is on that repo's main branch.
|
||
|
||
## Support PRs
|
||
|
||
Pages written to answer a user question come in as PRs titled `docs(support): <page title>`.
|
||
Review them like code: check every claim against the source.
|