Help page fabrications: "10-color", "BDFH" acronym, "14×8 inches" as universal (it's PR-1050X only), "9 stitch types" (5 selectable), "10-needle" optimization (only for multi-needle machines) — multiple stale claims after #126/#128/#136 landed #158

New issue

Closed

opened 2026-10-03 16:07:45 +00:00 by Mark · 1 comment

Mark commented

2026-10-03 16:07:45 +00:00

Owner

Finding

The Help page (src/pages/Help.tsx) carries multiple product claims that don't match the codebase, post-#126 and #136:

Line 94: "Every design automatically maps to the 10-color Brother PR-10 thread cartridge." The service has 61 colors (post #126), the client's local fallback has 20 colors (the original DEFAULT_THREAD_LIBRARY), and the user can add unlimited custom colors. "10-color" is a third invented number.
Line 106: "From the compact 4×4 to the jumbo 14×8 (BDFH), every standard and optional Brother hoop size is pre-configured in the workspace." The 14×8 figure is now accurate (the PR-1050X's max hoop is 360×200mm, per #136's MACHINE_PROFILES). But "BDFH" is a fictitious acronym — Brother calls the 14×8 hoop either the "Jumbo Hoop" or just "14×8 hoop." No "BDFH" appears in any Brother product literature.
Line 134: "ThreadCraft supports designs up to 14×8 inches (355×200mm), matching the largest Brother Entrepreneur hoop." The 14×8 figure is now accurate (the PR-1050X supports it post #136). The "(355×200mm)" is wrong though — 14×8 inches is 355.6×203.2mm, which rounds to 356×203mm or 355×200mm (close enough for prose). 14×8 is supported for the PR-1050X but not for the PR-680W (max 200×300mm) or PE-800 (max 130×180mm). The Help page makes a universal claim that depends on the user's machine profile.
Line 138: "ThreadCraft maps design colors to the closest match in the Brother PR-10 thread cartridge system using LAB color space comparison. The match is typically within 2–3 Delta-E." This is now accurate post #128 — the service does compute ΔE and the workspace stores it on the thread matches. But the user has no surface to see the ΔE value (the bottom thread bar and right panel can render it; the workspace doesn't currently show the per-color ΔE inline). The Help claim is technically correct but the user has no way to verify it.
Line 102: "Stitch sequences are optimized for 10-needle machines, minimizing color changes and thread trims for faster production runs." This is true for the PR-1050X and PR-1000e (10 needles each, per #136's MACHINE_PROFILES), but the 1-needle machines (PE-800, SE-1900, Persona PRS100) have no such optimization. The Help page makes a universal claim.
Help page still documents 9 stitch types (Satin, Fill, Running, Cross-Stitch, Motif, Zigzag, Bean, Applique, Stem) at line 78-95. The Editor's stitch type dropdown offers 5 (satin, fill, running, cross, zigzag) per the post-#139 fix. The 4 undocumented types (Motif, Bean, Applique, Stem) are visual-only (no selectable behavior). The user reads the documentation, looks in the editor, sees only 5.

Where

src/pages/Help.tsx:78-95, 94, 102, 106, 134, 138

Suggested fix shape

Five text updates in src/pages/Help.tsx:

Line 94: "Every design automatically maps to the Brother PR-10 thread cartridge, which provides 60+ colors for accurate production matching." (Drops the "10-color" fiction; matches the service's 61 colors.)
Line 106: "From the compact 4×4 to the jumbo 14×8 (the largest Brother Entrepreneur hoop), every standard and optional hoop size is pre-configured in the workspace." (Drops the "BDFH" acronym.)
Line 134: "ThreadCraft supports designs up to your selected machine's largest hoop — up to 14×8 inches (360×200mm) for the PR-1050X and PR-1000e, or 8×12 inches (200×300mm) for the PR-680W. Smaller machines (PE-800, SE-1900, Persona PRS100) max out at 5×7 or 8×8. The Machine Profile selector in Design Settings determines which hoops are available." (Reflects the per-machine hoop filtering from #136.)
Line 138: Add a sentence: "The match accuracy (ΔE) is shown in the Bottom Thread Bar and Right Panel; if a match is loose (ΔE > 5), pick a closer alternative from the alternatives list." (Tells the user where to find the ΔE value.)
Line 102: "For 6- and 10-needle machines, stitch sequences minimize color changes by grouping adjacent same-color regions. 1-needle machines don't have a multi-needle optimization, since the user manually swaps spools."
Stitch types documentation: trim the documented list to the 5 actually selectable in the editor. Move the other 4 (Motif, Bean, Applique, Stem) to a "Coming soon" section so the help page's promise matches the editor's reality. The Pattern SVG renderers stay (they're informational).

Severity

Medium. The Help page is the user's first reference for what the product can do. Stale claims lead to confused users, support tickets, and a credibility hit. Fixing the text is one PR; the content changes are mechanical.

Discovered by

Gap analysis (2026-10-02) of Help page text vs codebase reality.

#109 (closed) — fixed the "Steil Stitch" typo and other doc drift. The 9-stitch-types, BDFH, 10-color, and 14×8 claims are the same family of stale documentation.
#126 (closed) — service-sourced catalog. The 10-color claim predates this and never updated.
#128 (closed) — wired ΔE into the workspace. The Help claim was technically correct after this landed but the user has no surface to see the values; the surface work is separate.
#136 (closed) — added machine profiles. The 14×8 and 6/10-needle claims are partially right after this landed but the universal "10-needle" wording is wrong.
#139 (open) — Editor's Cross Stitch dropdown. Same documentation/implementation gap as the stitch-types list.

## Finding The Help page (`src/pages/Help.tsx`) carries multiple product claims that don't match the codebase, post-#126 and #136: 1. **Line 94**: "Every design automatically maps to the 10-color Brother PR-10 thread cartridge." The service has 61 colors (post #126), the client's local fallback has 20 colors (the original `DEFAULT_THREAD_LIBRARY`), and the user can add unlimited custom colors. "10-color" is a third invented number. 2. **Line 106**: "From the compact 4×4 to the jumbo 14×8 (BDFH), every standard and optional Brother hoop size is pre-configured in the workspace." The 14×8 figure is now accurate (the PR-1050X's max hoop is 360×200mm, per #136's `MACHINE_PROFILES`). But "BDFH" is a fictitious acronym — Brother calls the 14×8 hoop either the "Jumbo Hoop" or just "14×8 hoop." No "BDFH" appears in any Brother product literature. 3. **Line 134**: "ThreadCraft supports designs up to 14×8 inches (355×200mm), matching the largest Brother Entrepreneur hoop." The 14×8 figure is now accurate (the PR-1050X supports it post #136). The "(355×200mm)" is wrong though — 14×8 inches is 355.6×203.2mm, which rounds to 356×203mm or 355×200mm (close enough for prose). 14×8 is supported for the PR-1050X but not for the PR-680W (max 200×300mm) or PE-800 (max 130×180mm). The Help page makes a universal claim that depends on the user's machine profile. 4. **Line 138**: "ThreadCraft maps design colors to the closest match in the Brother PR-10 thread cartridge system using LAB color space comparison. The match is typically within 2–3 Delta-E." This is now accurate post #128 — the service does compute ΔE and the workspace stores it on the thread matches. But the user has no surface to see the ΔE value (the bottom thread bar and right panel can render it; the workspace doesn't currently show the per-color ΔE inline). The Help claim is technically correct but the user has no way to verify it. 5. **Line 102**: "Stitch sequences are optimized for 10-needle machines, minimizing color changes and thread trims for faster production runs." This is true for the PR-1050X and PR-1000e (10 needles each, per #136's MACHINE_PROFILES), but the 1-needle machines (PE-800, SE-1900, Persona PRS100) have no such optimization. The Help page makes a universal claim. 6. **Help page still documents 9 stitch types** (Satin, Fill, Running, Cross-Stitch, Motif, Zigzag, Bean, Applique, Stem) at line 78-95. The Editor's stitch type dropdown offers 5 (satin, fill, running, cross, zigzag) per the post-#139 fix. The 4 undocumented types (Motif, Bean, Applique, Stem) are visual-only (no selectable behavior). The user reads the documentation, looks in the editor, sees only 5. ## Where `src/pages/Help.tsx:78-95, 94, 102, 106, 134, 138` ## Suggested fix shape Five text updates in `src/pages/Help.tsx`: 1. **Line 94**: "Every design automatically maps to the Brother PR-10 thread cartridge, which provides 60+ colors for accurate production matching." (Drops the "10-color" fiction; matches the service's 61 colors.) 2. **Line 106**: "From the compact 4×4 to the jumbo 14×8 (the largest Brother Entrepreneur hoop), every standard and optional hoop size is pre-configured in the workspace." (Drops the "BDFH" acronym.) 3. **Line 134**: "ThreadCraft supports designs up to your selected machine's largest hoop — up to 14×8 inches (360×200mm) for the PR-1050X and PR-1000e, or 8×12 inches (200×300mm) for the PR-680W. Smaller machines (PE-800, SE-1900, Persona PRS100) max out at 5×7 or 8×8. The Machine Profile selector in Design Settings determines which hoops are available." (Reflects the per-machine hoop filtering from #136.) 4. **Line 138**: Add a sentence: "The match accuracy (ΔE) is shown in the Bottom Thread Bar and Right Panel; if a match is loose (ΔE > 5), pick a closer alternative from the alternatives list." (Tells the user where to find the ΔE value.) 5. **Line 102**: "For 6- and 10-needle machines, stitch sequences minimize color changes by grouping adjacent same-color regions. 1-needle machines don't have a multi-needle optimization, since the user manually swaps spools." 6. **Stitch types documentation**: trim the documented list to the 5 actually selectable in the editor. Move the other 4 (Motif, Bean, Applique, Stem) to a "Coming soon" section so the help page's promise matches the editor's reality. The Pattern SVG renderers stay (they're informational). ## Severity Medium. The Help page is the user's first reference for what the product can do. Stale claims lead to confused users, support tickets, and a credibility hit. Fixing the text is one PR; the content changes are mechanical. ## Discovered by Gap analysis (2026-10-02) of Help page text vs codebase reality. ## Related - #109 (closed) — fixed the "Steil Stitch" typo and other doc drift. The 9-stitch-types, BDFH, 10-color, and 14×8 claims are the same family of stale documentation. - #126 (closed) — service-sourced catalog. The 10-color claim predates this and never updated. - #128 (closed) — wired ΔE into the workspace. The Help claim was technically correct after this landed but the user has no surface to see the values; the surface work is separate. - #136 (closed) — added machine profiles. The 14×8 and 6/10-needle claims are partially right after this landed but the universal "10-needle" wording is wrong. - #139 (open) — Editor's Cross Stitch dropdown. Same documentation/implementation gap as the stitch-types list.

Mark added the

bug

triage-approved

labels

2026-10-03 16:07:45 +00:00

Mark referenced this issue

2026-10-03 17:30:28 +00:00

Workspace MM_TO_PX = 2 is a constant, not device-DPI-accurate — the "Hoop-accurate canvas: Work on a 1:1 scale representation of your actual Brother hoop" Home page claim is unfulfilled #163

Mark referenced this issue from a commit

2026-10-03 17:32:53 +00:00

fix(#158): Help page no longer claims 10 colors, BDFH, 14×8 universal, 10-needle optimization, or 9 stitch types

Mark commented

2026-10-03 17:33:16 +00:00

Author

Owner

Fixed on commit 668a9d1 (origin/main).

Compatibility cards: dropped "10-color" fiction (service has 60+), dropped "BDFH" acronym, scoped multi-needle optimization to 6/10-needle machines, dropped "14×8" universal hoop claim.
FAQ: per-machine hoop limits now reflect MACHINE_PROFILES (#136); ΔE mention now points users to Bottom Thread Bar / Right Panel (#128).
Stitch Types grid split into "Available in Editor" (5 cards: satin, fill, running, cross-stitch, zigzag) and "Coming Soon" (4 previews: motif, bean, applique, stem). All 9 names still render — only the section organization changed.

TypeScript build clean. 675/675 tests pass. ESLint clean. PR diff: Mark/Kimi_Agent_Brother_10_Digitizing_App@fb4ed81...668a9d1

Fixed on commit 668a9d1 (origin/main). - Compatibility cards: dropped "10-color" fiction (service has 60+), dropped "BDFH" acronym, scoped multi-needle optimization to 6/10-needle machines, dropped "14×8" universal hoop claim. - FAQ: per-machine hoop limits now reflect MACHINE_PROFILES (#136); ΔE mention now points users to Bottom Thread Bar / Right Panel (#128). - Stitch Types grid split into "Available in Editor" (5 cards: satin, fill, running, cross-stitch, zigzag) and "Coming Soon" (4 previews: motif, bean, applique, stem). All 9 names still render — only the section organization changed. TypeScript build clean. 675/675 tests pass. ESLint clean. PR diff: https://forgejo.tail018ac4.ts.net/Mark/Kimi_Agent_Brother_10_Digitizing_App/compare/fb4ed81...668a9d1

Mark closed this issue

2026-10-03 17:33:16 +00:00

Mark referenced this issue

2026-10-03 17:34:26 +00:00

Workspace has no image rotate, flip, or crop UI — UploadedImage type has rotation field and the canvas honors it, but no controls #174

Mark referenced this issue

2026-10-03 17:34:26 +00:00

Help page "Stitch sequences are optimized for 10-needle machines" claim unfulfilled — there's no machine-specific stitch sequence optimization in the codebase #175

Mark referenced this issue

2026-10-03 18:54:06 +00:00

Editor exposes 12+ keyboard shortcuts (n/a/d/c/p/s/m/z tool letters, Ctrl+Z/Y/A, Tab, Enter, Escape, Space, Delete/Backspace) but Help page documents zero #178

Mark referenced this issue from a commit