Fabio LussiandClaude Opus 5.5
436c56a7ad
User docs in docs/user/ (published at getartcraft.com/docs/lightcraft), the docs-check and docs-publish workflows, and a "User docs" rule in AGENTS.md. Modelled on the ArtCraft Launcher setup. Sources per page: - index.md: README.md, crafting-apps.ts (lightcraft entry), Cargo.toml (0.6.0) - getting-started/install.md: README Downloads section, `gh release view` v0.6.0 asset list, craft-launcher catalog.rs and install docs - guides/import-photos.md: crates/ui-egui/src/import.rs, panels/dialogs.rs, menubar.rs, menus.rs - guides/cull-photos.md: docs/library-shortcuts.md, menubar.rs, panels/compare.rs, README - guides/edit-a-photo.md: panels/edit.rs, develop/src/controls.rs, menus.rs, README - guides/export-photos.md: panels/dialogs.rs (Export dialog), menus.rs - guides/import-lightroom-catalog.md: docs/lightroom-catalog-import.md, menus.rs, issue #832 - troubleshooting/preview-only-raw.md: issue #662, widgets.rs, engine cmd/convert.rs, README - troubleshooting/raw-photos-look-dull.md: issues #860, #778, #697 - troubleshooting/get-help.md: README (logs), menus.rs Help menu, issue #860 - faq/free-and-private.md: README (local-first, license), ROADMAP link - faq/supported-files.md: README, menus.rs, export dialog Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2.7 KiB
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/lightcraft. The file path is the URL:
troubleshooting/raw-photos-look-dull.md → /docs/lightcraft/troubleshooting/raw-photos-look-dull.
Renaming a file breaks links, so add the old path to redirect_from when you rename.
Who reads this
Artists and photographers using LightCraft, Discord mods answering them, and AI assistants looking things up for either. Write for a photographer, 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
.mdfile:[Install LightCraft](../getting-started/install.md). - No marketing copy, no "simply", no claims you have not checked in the code or a release.
- Call the product "LightCraft", as the app, its downloads and getartcraft.com do.
- Name UI labels exactly as the app shows them, in bold.
- Troubleshooting pages:
## Symptoms,## Fix,## Why this happens(optional),## Still stuck?(link the issue tracker or Discord).
Frontmatter
---
title: Raw photos look dull
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/lightcraft)
---
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 Cargo.toml whenever you check a
page against the current code.
Folders
getting-started/install and first runguides/how to do one thingtroubleshooting/symptom → fixfaq/short answersreference/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.