mirror of
https://github.com/storytold/designcraft.git
synced 2026-10-28 12:16:53 -06:00
Fabio LussiandClaude Opus 5.5
2dca7e220e
Baseline user docs in docs/user/ (published at getartcraft.com/docs/designcraft), the docs-check and docs-publish workflows, and a "User docs" rule in AGENTS.md. Source notes per page: - index.md: README (intro, features, license), website crafting-apps.ts entry. - getting-started/index.md: crates/ui-egui/src/chrome.rs start_screen buttons. - getting-started/install.md: README Downloads, gh release view v0.6.0 asset list, packaging/windows/designcraft.wxs (Start Menu shortcut), launcher catalog.rs. - guides/create-a-document.md: dialogs.rs newDocument dialog, build.rs PRESETS, menus.rs UI_COMMANDS, chrome.rs start screen. - guides/open-a-file.md: apps/designcraft main.rs open_filters, engine file.rs and interchange.rs docs, lib.rs import warnings test, issue #110. - guides/place-images-and-text.md: main.rs place filters, engine file.rs file.place, dialogs.rs pdfImport, menus.rs placeWithOptions, release notes (#80). - guides/export-a-pdf.md: dialogs.rs pdf_export and apply_pdf_preset, menus.rs. - troubleshooting/app-closes-at-start.md: README graphics backend and logs, apps/designcraft/src/gpu.rs, issues #167, #192, #220, #273. - troubleshooting/get-help.md: README Logs section. - faq/is-it-free.md: README, docs/gaps.md. faq/supported-systems.md: README, release assets. faq/indesign-files.md: main.rs open filters, issues #450, #451, #110. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
65 lines
2.8 KiB
Markdown
65 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/designcraft. The file path is the URL:
|
|
`troubleshooting/app-closes-at-start.md` → `/docs/designcraft/troubleshooting/app-closes-at-start`.
|
|
Renaming a file breaks links, so add the old path to `redirect_from` when you rename.
|
|
|
|
## Who reads this
|
|
|
|
Artists and designers using DesignCraft, 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 DesignCraft](../getting-started/install.md)`.
|
|
- No marketing copy, no "simply", no claims you have not checked in the code or a release.
|
|
- Call the product "DesignCraft", as the app, its downloads and getartcraft.com do.
|
|
- Name UI labels exactly as the app shows them, in **bold**.
|
|
- Document Windows 11 only. Do not name older Windows versions.
|
|
- Troubleshooting pages: `## Symptoms`, `## Fix`, `## Why this happens` (optional),
|
|
`## Still stuck?` (link the issue tracker or Discord).
|
|
|
|
## Frontmatter
|
|
|
|
---
|
|
title: App closes right after it starts
|
|
description: One sentence for search results, link previews and AI summaries.
|
|
order: 10 # optional, sorts within the folder (lower first)
|
|
verified: 0.6.0 # optional, app version you last checked this page against
|
|
redirect_from: [old/path] # optional, old URLs (relative to /docs/designcraft)
|
|
---
|
|
|
|
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.
|
|
|
|
## 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
|
|
|
|
curl -fsSL https://raw.githubusercontent.com/storytold/artcraft-services/main/frontend/apps/artcraft-website-next/scripts/docs/core.mjs -o /tmp/docs-core.mjs
|
|
node /tmp/docs-core.mjs docs/user
|
|
|
|
CI runs the same check on every PR that touches `docs/user/`.
|
|
|
|
## 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. Questions and bugs go to
|
|
https://github.com/storytold/designcraft/issues.
|