F37: friendly non-technical Help + FAQ (draft) - #3
Draft
AmigoUK wants to merge 2 commits into
Draft
Conversation
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>
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
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.
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.TODO-<name>placeholders for frames not yet captured — same name used in bothpl/anden/paths so the pair stays linked (see full list below).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.Line counts (before → after):
docs/HELP.pl.mddocs/HELP.en.mddocs/FAQ.pl.mddocs/FAQ.en.mdScreenshots still to capture (46
TODO-<name>placeholders)Each appears identically in
docs/screenshots/help/pl/TODO-<name>.pnganddocs/screenshots/help/en/TODO-<name>.png, greppable viagrep -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 highlightedTODO-new-template-button— Templates page with "New template" button highlightedTODO-new-template-dialog— "New template" dialog, name filled in, Predefined vs Custom size choice, width/height fields shownTODO-new-template-dialogfor 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) labelledSection 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 + SaveTODO-folder-edit— folder rename/color dialog (✎), 8-color paletteTODO-library-page— Library page, both sections (Ready-made projects / From users)TODO-share-template— ⚙ menu with "Share in the Library" ticked + featured-image uploadSection 3 — Object guide
TODO-object-text— Text object selected + Content fieldTODO-object-textblock— Text block selected, Auto-fit ticked, min/max font fieldsTODO-object-shapes— rectangle + line on canvas, fill/stroke pickersTODO-object-barcode— Barcode object, type dropdown + Data fieldTODO-object-table— Table object, rows/cols fields, cell with{{column}}, Bold headerTODO-object-image— uploaded logo as Image objectTODO-object-background— full-canvas Background image, Lock position / Print in PDF checkboxesSection 4 — Working with objects
TODO-multiselect— 3 objects selected at once (Shift+click)TODO-resize-handles— selected object with corner resize + rotate handlesTODO-undo-redo-buttons— toolbar Undo/Redo close-upTODO-duplicate-altdrag— Alt+drag duplication mid-actionTODO-layer-buttons— alignment bar Layer group close-upTODO-lock-print-checkboxes— right panel Lock position / Print in PDF, object faded on canvasTODO-autosave-status— toolbar autosave status statesTODO-version-history— History panel with version list + Restore buttonSection 5 — Single PDF
TODO-preview-pdf— in-app PDF preview + Download PDF buttonTODO-warnings-chip— toolbar "N warnings" chip with tooltip openSection 6 — Series generation
TODO-series-step1-upload— Step 1 file picker + format/size/row-limit tableTODO-series-csv-preview— detected columns + row count after CSV uploadTODO-series-sqlite-tables— table list sorted by row count after SQLite uploadTODO-series-sqlite-sql— "Show advanced" SQL query panel expandedTODO-series-filter— Step 3 filter with condition set + Test filter resultTODO-series-progress— Step 4 progress bar mid-generationTODO-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 .txtTODO-connector-add-device— "Add device" dialog with generated tokenTODO-connector-print-dialog— editor Print dialog, device/printer/copies/DPI, progress statesTODO-connector-fastpath— Print dialog with "⚡ This computer — instant print" preselectedTODO-devices-inbox— Devices → Inbox list with captured labels + Open in editorSection 7c — History
TODO-generated-history— History page list (name/type/count/size/date) + Download/DeleteSection 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 displayTODO-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-upTODO-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
HelpPage.tsx(PL and EN) and confirm the markdown renders cleanly (tables, code fences, headings, existing images all resolve).TODO-*screenshots (PL + EN, 23 distinct frames each) and rename them to drop theTODO-prefix, matching the paths already referenced in the markdown.🤖 Generated with Claude Code