Repository navigation
docs: add user docs in docs/user - #2187
Open
itrycodinganditsbad wants to merge 15 commits into
Open
itrycodinganditsbad wants to merge 15 commits into
itrycodinganditsbad wants to merge 15 commits into
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Source notes (all pages verified: 0.42.0, tauri.conf.json version): index.md: ordering from the pages below; links to guides/troubleshooting/faq pages that do not exist yet. install-windows.md: requirements (Windows 10 64-bit, 8 GB RAM, 2 GB) and the "Download for Windows" label from artcraft-website-next download-page.tsx; asset names from `gh release view artcraft-v0.41.0` and download-links.ts; no updater plugin in crates/desktop/artcraft/Cargo.toml. Left out: SmartScreen prompt and install location (no source in repo, workflow or releases). install-macos.md: macOS 12.0 from download-page.tsx (tauri*.conf.json has no minimumSystemVersion); universal dmg from release assets and artcraft-macos-publish.yml (universal-apple-darwin, Developer ID signing); Monterey sign-up freeze per storytold#1008 (closed, PR storytold#1042). Left out: Gatekeeper prompt wording (no source). install-linux.md: no Linux assets in release 0.41.0; PR storytold#2007 (open) adds .deb/AppImage; issues storytold#2002, storytold#1392, storytold#2075, storytold#2035, storytold#1974 (open); storytold#2055 and PR storytold#2056 (open) for the Wayland DMABUF crash; README "Build from source, including Linux"; script/artcraft/unix_build.sh. Left out: AUR/community packages, distro support lists, maintainer remarks on Tauri (storytold#2035). sign-up-and-log-in.md: labels from frontend/libs/components/login-modal (login-modal.tsx, artcraft-signup.tsx, DesktopLoginBridge.tsx) and settings-modal ArtcraftAccountBlock.tsx; flow from docs/website-login.md; storytold#2004 (open, one user's workaround stated as unconfirmed). credits-and-pricing.md: labels from BillingSettingsPane.tsx, credits-modal.tsx, cost-calculator-button.tsx, subscription-plans.ts (plan names, Free plan features); credits-state.ts (monthly/banked); live https://getartcraft.com/pricing (no subscription needed, packs never expire, refund on failure). No prices copied. Left out: free credit amount (code comment says "if/when we offer"). connect-provider-accounts.md: AccountSettingsPane.tsx, GrokAccountBlock.tsx, MidjourneyAccountBlock.tsx, provider-setup-modal.tsx, classy-model-selector.tsx ("Select Provider"), PromptBoxImage.tsx (Midjourney shows 0 credits); README provider table; storytold#1525, storytold#1172. Left out: Sora/World Labs/Fal setup (no Accounts UI), how Grok is billed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
index.md: first-image link now ../guides/text-to-image.md (planned guide name). install-linux.md: AppImage path is a placeholder for the self-built file; says the env var matters only for release builds because the dev scripts already set it (issue storytold#2055, PR storytold#2056 body). install-windows.md: artcraft-windows-publish.yml has no signing step and tauri.conf.json has no Windows signing config, so SmartScreen warning is expected. Source for SmartScreen: Microsoft Learn overview. The "More info" then "Run anyway" steps are the standard ones; the linked page does not list them. install-macos.md: artcraft-macos-publish.yml passes APPLE_SIGNING_IDENTITY (Developer ID) and APPLE_ID/APPLE_PASSWORD/APPLE_TEAM_ID to tauri-action (notarization credentials; result not verified). Fallback steps from Apple support "Safely open apps on your Mac" (support.apple.com/en-us/102445). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sources per page (all verified against 0.42.0): - reference/models.md: frontend/libs/model-list/src/lib/loader/buildModelsFromListing.ts (membership and order come from the backend listing). Table is generated. - troubleshooting/linux-wayland-crash.md: issue storytold#2055 (error text, env var, environment) and PR storytold#2056 (open, unmerged). - troubleshooting/generation-stuck-or-failed.md: TopBar/TaskQueue.tsx (95% cap on a time-based estimate, "Almost done...", 5 minute dismiss, Clear stale, Clear failed, failure reason labels), storyteller_task_polling_thread (5 s poll, failure type and message), issues storytold#1058, storytold#1068, storytold#1439, storytold#1175, storytold#985. Refunds: pricing page text plus maintainer comment on storytold#1068; not in app code. - faq/local-models.md: issues storytold#968, storytold#1147, ROADMAP.md (no local model entry). Left out: refund timing or amounts, a Seedance fix version, any claim that Wayland workaround works beyond the one reporter. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Eight pages under docs/user/guides, verified against 0.42.0. Sources per page (frontend paths under frontend/): - text-to-image: apps/artcraft/app/src/pages/PageImage/TextToImage.tsx, libs/components/promptbox/.../PromptBoxImage.tsx, settings-modal MiscSettingsPane (Enter to generate), pricing-modal Costs button, config/appMenu.tsx; prompt tips from faq/text-to-image.md. - edit-an-image: PageDraw/BaseImageSelector.tsx, pagedraw PageDraw.tsx (generate cases, usesInpaintingMask), InpaintToolBar, SideToolbar, BlankCanvasModal, TopBar handleEditFromGallery; faq/edit-image.md. - image-to-video: PageVideo/ImageToVideo.tsx, PromptBoxVideo.tsx, KeyframeCards.tsx, DesktopGenerationGallery (Make Video), desktopMediaActions.applyMakeVideoFromImage; faq/image-to-video.md. - 2d-canvas: pagedraw SideToolbar, ContextMenu, BlankCanvasModal, PromptBox2D, keybinds registry; faq/2d-canvas.md and tutorials/2d-editor-basics.md (video link only). - 3d-editor: pagescene Controls3D, ControlsTopButtons, SceneModePill, CameraStatusPill, AspectRatioMenu, Outliner, RecordControls, PromptBox3D, AssetModal; faq/3d-editor.md, tutorials/3d-editor-basics.md. - image-to-3d: components/experiences/ImageTo3DExperience.tsx, config/appMenu.tsx, lightbox Make 3D, pagescene wand button; tutorials/turn-images-into-objects.md (video link only). - library: gallery-modal.tsx, GalleryItemMenuItems.tsx, GalleryDraggableItem.tsx, lightbox-modal.tsx, TopBar.tsx, DownloadsSettingsPane.tsx; issue storytold#969 (closed 2026-01-26). Left out as not confirmed in the current UI: "runs locally", live inpaint of small regions as a separate feature, Text to 3D mode (tab is commented out), Image to 3D World, keyboard shortcut lists. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Clear stale: TaskQueue.tsx:719 sets canDismiss for in-progress tasks older than 5 minutes; dismissStale (:977-978) dismisses exactly those. The button is in the Task Queue window header (:1179-1182), opened by Show all. Added what to do when a task never moves to Failed (storytold#1068, storytold#1439). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Items 1-5, 7-13. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Part 1: verified = latest release tag policy in docs/user/AGENTS.md; released-pages sentence in root AGENTS.md. Part 2 items 1-5: verified 0.41.0, account labels, credits wording, unreleased note. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
❌ Deploy Preview for storyteller-docs failed. Why did it fail? →
|
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…es main Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
A symlink may not check out on Windows. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds user docs for ArtCraft in
docs/user/: getting started (6 pages), guides (7 pages), reference (1 page), troubleshooting (2 pages) and FAQ (1 page). They'll be published at https://getartcraft.com/docs/artcraft once storytold/artcraft-services#134 merges; until then GitHub renders them fine.Every page was checked against the artcraft-v0.41.0 release (code at the tag, release files, issues) and carries
verified: 0.41.0. Fixes that are merged but not released are described as "not in a release yet". I didn't run the app, so UI labels come from the code.Also adds
docs/user/AGENTS.md, the writing rules for people and agents. The PR only touchesdocs/user/.A docs check workflow and a rebuild hook will follow in a separate PR once the checker is on artcraft-services main.
🤖 Generated with Claude Code