mirror of
https://github.com/storytold/effectcraft.git
synced 2026-10-30 13:08:07 -06:00
Fabio LussiandClaude Opus 5.5
a6ab6a8f8c
Adds docs/user/ (published at getartcraft.com/docs/effectcraft), the docs-check and docs-publish workflows (copied from craft-launcher), and a "User docs" rule in AGENTS.md. Verified against 0.8.0. Source notes per page: - index: README, crates/engine/src/menus.rs, website crafting-apps.ts entry, docs/gaps.md (.aep). - getting-started/install: README Downloads, gh release v0.8.0 assets, packaging/windows/effectcraft.wxs (per-machine, Start Menu, desktop shortcut box), package.ps1 (portable zip contents), launcher crates/core catalog.rs (EffectCraft listed), launcher docs install guide. - guides/make-a-composition: menus.rs (Composition, Layer, Help), comp.rs shortcut, panels/comp_settings.rs (labels, presets, tabs), panels/home.rs, engine/src/learn.rs (Animate a title tutorial). - guides/animate-with-keyframes: learn.rs, panels/timeline.rs (stopwatch, Add or remove keyframe), commands/prop.rs (Easy Ease F9), menus.rs (Animation). - guides/add-an-effect: menus.rs (Effect, Window), panels/effects_presets.rs, commands/effect.rs, effects/src/misc.rs (Gaussian Blur parameters). - guides/render-a-video: panels/render_queue.rs (labels), project render_queue.rs (format labels, default H.264, template, supports_alpha), commands/render_queue.rs (Cmd+M), README (Lottie). - guides/import-footage: docs/footage.md, menus.rs, engine/src/prefs.rs (Sequence Footage), README (Wayland drop). - troubleshooting/gpu-not-used: issues #596, #613; prefs.rs (Window Graphics), commands/app_more.rs (System Compatibility Report text), ui-egui menus.rs (GPU Information dialog text, checked at v0.8.0). - troubleshooting/footage-missing: docs/footage.md (relink), commands/ file_more.rs (Find Missing Footage), issue #652 and PR #676. - faq/after-effects-projects: README "Where it stands", docs/gaps.md. - faq/price-and-platforms: README (license, platforms, status), LICENSE files. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
67 lines
3.0 KiB
Markdown
67 lines
3.0 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/effectcraft. The file path is the URL:
|
|
`troubleshooting/gpu-not-used.md` → `/docs/effectcraft/troubleshooting/gpu-not-used`.
|
|
Renaming a file breaks links, so add the old path to `redirect_from` when you rename.
|
|
|
|
## Who reads this
|
|
|
|
Artists using EffectCraft, 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 EffectCraft](../getting-started/install.md)`.
|
|
- No marketing copy, no "simply", no claims you have not checked in the code, a release or an issue.
|
|
- Call the product "EffectCraft", as the app, its downloads and getartcraft.com do.
|
|
- Name UI labels exactly as the app shows them, in **bold**. Menu paths use the menu text from
|
|
`crates/engine/src/menus.rs`.
|
|
- Shortcuts: the code writes `Cmd`, which is Ctrl on Windows and Linux. Write Ctrl for Windows.
|
|
- Windows 11 is the only Windows version to name.
|
|
- Troubleshooting pages: `## Symptoms`, `## Fix`, `## Why this happens` (optional),
|
|
`## Still stuck?` (link the issue tracker or Discord).
|
|
|
|
## Frontmatter
|
|
|
|
---
|
|
title: EffectCraft does not use my graphics card
|
|
description: One sentence for search results, link previews and AI summaries.
|
|
order: 10 # optional, sorts within the folder (lower first)
|
|
verified: 0.8.0 # optional, app version you last checked this page against
|
|
redirect_from: [old/path] # optional, old URLs (relative to /docs/effectcraft)
|
|
---
|
|
|
|
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. Problems and bug reports go in the
|
|
[issue tracker](https://github.com/storytold/effectcraft/issues).
|