Skip to content

F37: friendly non-technical Help + FAQ (draft) - #3

Draft
AmigoUK wants to merge 2 commits into
mainfrom
f37-friendly-help
Draft

F37: friendly non-technical Help + FAQ (draft)#3
AmigoUK wants to merge 2 commits into
mainfrom
f37-friendly-help

Conversation

@AmigoUK

@AmigoUK AmigoUK commented Jul 5, 2026

Copy link
Copy Markdown
Owner

Summary

Rewrites the in-app Help + FAQ (docs/HELP.pl.md, docs/HELP.en.md, docs/FAQ.pl.md, docs/FAQ.en.md) for non-technical office staff, per backlog item F37.

  • Plain language, no unexplained jargon. Every unavoidable technical term (placeholder, ZPL, DPI, konektor/connector, SQLite, TSPL, token, sha256, CSRF) is explained in one simple sentence the first time it appears in each file.
  • Short numbered steps instead of dense paragraphs, second person, friendly/encouraging tone.
  • One screenshot per meaningful step. Reused all 10 existing screenshots where they fit (login, templates list, editor overview, label size, dynamic fields, series mapping, date chip, ZPL import/export, users admin). Added 46 new TODO-<name> placeholders for frames not yet captured — same name used in both pl/ and en/ paths so the pair stays linked (see full list below).
  • Only documents realised features from docs/PROJECT.md §2.2. This includes a new small section on TSPL export (F22, v0.20.0) — export-only, single label, DPI choice, Copy/Download .txt — which was live in the app but had never been documented in Help/FAQ before. Per F22's scope note, agent-printing of TSPL and TPCL are explicitly called out as not supported yet.
  • PL/EN kept in exact structural parity — same section/heading count and order in both languages (verified: 63 headings in each HELP file, identical heading sequence in each FAQ file).
  • FAQ intentionally stays screenshot-free (matches its original convention) and cross-references the relevant HELP.md section for the visual walkthrough.

Line counts (before → after):

File Before After
docs/HELP.pl.md 484 671
docs/HELP.en.md 484 671
docs/FAQ.pl.md 311 311
docs/FAQ.en.md 309 311

Screenshots still to capture (46 TODO-<name> placeholders)

Each appears identically in docs/screenshots/help/pl/TODO-<name>.png and docs/screenshots/help/en/TODO-<name>.png, greppable via grep -rn "TODO-" docs/HELP.*.md.

Section 1 — Getting started

  • TODO-set-new-password — forced password-change screen on first login (new/confirm password fields, "min 10 characters" hint, Set password button)
  • TODO-dashboard-empty — Dashboard right after login, "Templates" menu item highlighted
  • TODO-new-template-button — Templates page with "New template" button highlighted
  • TODO-new-template-dialog — "New template" dialog, name filled in, Predefined vs Custom size choice, width/height fields shown
  • (shares TODO-new-template-dialog for the format-selection step too — no separate frame needed)

Section 2 — Menus

  • TODO-alignment-bar-groups — close-up of the 4 alignment-bar groups (Page/Selection/Layer/Distribute) labelled

Section 2a — Folders / Library

  • TODO-folder-rail — folder rail (All, example folders w/ colored dots+counts, No folder, New folder button)
  • TODO-folder-menu — template card's ⚙ menu open with folder picker + Save
  • TODO-folder-edit — folder rename/color dialog (✎), 8-color palette
  • TODO-library-page — Library page, both sections (Ready-made projects / From users)
  • TODO-share-template — ⚙ menu with "Share in the Library" ticked + featured-image upload

Section 3 — Object guide

  • TODO-object-text — Text object selected + Content field
  • TODO-object-textblock — Text block selected, Auto-fit ticked, min/max font fields
  • TODO-object-shapes — rectangle + line on canvas, fill/stroke pickers
  • TODO-object-barcode — Barcode object, type dropdown + Data field
  • TODO-object-table — Table object, rows/cols fields, cell with {{column}}, Bold header
  • TODO-object-image — uploaded logo as Image object
  • TODO-object-background — full-canvas Background image, Lock position / Print in PDF checkboxes

Section 4 — Working with objects

  • TODO-multiselect — 3 objects selected at once (Shift+click)
  • TODO-resize-handles — selected object with corner resize + rotate handles
  • TODO-undo-redo-buttons — toolbar Undo/Redo close-up
  • TODO-duplicate-altdrag — Alt+drag duplication mid-action
  • TODO-layer-buttons — alignment bar Layer group close-up
  • TODO-lock-print-checkboxes — right panel Lock position / Print in PDF, object faded on canvas
  • TODO-autosave-status — toolbar autosave status states
  • TODO-version-history — History panel with version list + Restore button

Section 5 — Single PDF

  • TODO-preview-pdf — in-app PDF preview + Download PDF button
  • TODO-warnings-chip — toolbar "N warnings" chip with tooltip open

Section 6 — Series generation

  • TODO-series-step1-upload — Step 1 file picker + format/size/row-limit table
  • TODO-series-csv-preview — detected columns + row count after CSV upload
  • TODO-series-sqlite-tables — table list sorted by row count after SQLite upload
  • TODO-series-sqlite-sql — "Show advanced" SQL query panel expanded
  • TODO-series-filter — Step 3 filter with condition set + Test filter result
  • TODO-series-progress — Step 4 progress bar mid-generation
  • TODO-series-warnings-list — post-generation warnings list (rows/objects)

Section 7a — ZPL/TSPL & connector

  • TODO-tspl-export — "Export TSPL" modal, DPI choice, live code preview, Copy/Download .txt
  • TODO-connector-add-device — "Add device" dialog with generated token
  • TODO-connector-print-dialog — editor Print dialog, device/printer/copies/DPI, progress states
  • TODO-connector-fastpath — Print dialog with "⚡ This computer — instant print" preselected
  • TODO-devices-inbox — Devices → Inbox list with captured labels + Open in editor

Section 7c — History

  • TODO-generated-history — History page list (name/type/count/size/date) + Download/Delete

Section 8 — Administration

  • TODO-admin-create-user — "Create account" dialog (email, temp password + Generate, role dropdown)
  • TODO-admin-reset-password — Reset password action + one-time password display
  • TODO-admin-active-toggle — Active toggle in a user row (own row disabled)

Section 8a — Import/export templates

  • TODO-editor-export-button — toolbar ⬇ Export button close-up
  • TODO-import-step1 — import wizard step 1 (file picked, validity check, preview)
  • TODO-import-step2 — import wizard step 2 (name, size override, object checklist, duplicate-image choice)

Test plan

  • Render both HELP tabs and both FAQ tabs in HelpPage.tsx (PL and EN) and confirm the markdown renders cleanly (tables, code fences, headings, existing images all resolve).
  • Capture the 46 TODO-* screenshots (PL + EN, 23 distinct frames each) and rename them to drop the TODO- prefix, matching the paths already referenced in the markdown.
  • Spot-check Polish diacritics render correctly in the app.

🤖 Generated with Claude Code

AmigoUK and others added 2 commits July 5, 2026 07:43
Rewrites docs/HELP.{pl,en}.md and docs/FAQ.{pl,en}.md for a non-technical
bakery-office audience: short numbered steps, jargon explained inline on
first use (placeholder, ZPL, DPI, konektor/connector, SQLite, TSPL,
sha256, token, CSRF), and one screenshot per meaningful step. Reuses the
10 existing help screenshots and adds 46 TODO-<name> placeholders (paired
identically in pl/ and en/) for frames not yet captured. Also documents
the TSPL export feature (F22, editor-only, no batch/import), which was
previously missing from the in-app help. PL/EN kept in exact structural
parity (same section/heading order and count in both languages).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…d section (F37/F38)

Capture all 46 placeholder screenshots (plus the 6 F38 wizard steps) in PL
and EN via a rewritten, reproducible tools/capture-help-screenshots.py
(data-driven; folders/templates/devices/captures seeded through the app's
own API, checked-before-created; a dedicated object-gallery template covers
every canvas object type; a real blg-connector on loopback provides genuine
fast-path/connected states). Drop the TODO- filename prefix and the
"SCREENSHOT:" alt marker. Add a "Connect a printer wizard" subsection to the
connector help (the old manual token flow becomes "Advanced").

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant