8000 Add task guides under docs/guides by jasonmadigan · Pull Request #279 · tracefinity/tracefinity · GitHub
[go: up one dir, main page]

Skip to content

Add task guides under docs/guides - #279

Merged
jasonmadigan merged 4 commits into
mainfrom
docs/guides
Nov 15, 2026
Merged

jasonmadigan merged 4 commits into
mainfrom
docs/guides

Conversation

@jasonmadigan
Copy link
Copy Markdown
Collaborator

Summary

docs/usage describes each screen. Nothing walked through a whole job, such as getting a thick tool to the right size or printing a bin bigger than the bed. This adds 18 short task guides, each checked against the code at a73e0e6.

docs/guides/
├── README.md        # index by category, linked from the README's docs list
├── *.md             # 18 guides: start here, photos and tracing, designing bins, printing and planning
└── images/<slug>/   # 17 SVG diagrams, 21 @2x PNG screenshots
frontend/scripts/guide-screenshots.ts  # retakes the PNGs against a running instance
docs/usage/projects.md                 # Clear drawer size and Auto arrange corrected

Evidence

  • Links: every relative link, image and anchor in docs/guides resolves (88 checked).
  • Screenshots: the script run against ghcr.io/tracefinity/tracefinity:0.11.0 with AUTH_MODE=open.
    Before: the overhang shot came out different on every run, captured while its outline faded in.
    After: all 21 shots repeat; 20 byte-identical, one with 10 pixels off by 1/255.
  • Fixture check: with one tool and one photo removed from the library, the script exits 1, lists both and takes no shots.
  • Type-check: the script is under frontend/, so tsc --noEmit and next build cover it. Both pass.

Merge Danger

Door: two-way

Docs and a dev-only script.

Blast Radius: docs

The app never imports the script. The photos it needs are not in the repository because of their size (about 40 MB). Screenshots show the one-tracer flow, so the step bar reads Corners · Save.

Eighteen step-by-step guides, one job each, with their screenshots and
diagrams, indexed from the README's list of guides. Screenshots are retaken
by frontend/scripts/guide-screenshots.ts against a running instance.

Signed-off-by: Jason Madigan <jason@jasonmadigan.com>
Clear drawer size keeps the plan and the project bins. Auto arrange keeps
placements it cannot fit and only seeds an empty plan.

Relates to #278

Signed-off-by: Jason Madigan <jason@jasonmadigan.com>
The script now stops before taking any shot when the library lacks one of
its tools or sessions, or a photo or mask they show, and lists each one.

Signed-off-by: Jason Madigan <jason@jasonmadigan.com>
The selected outline eases in over 150 ms, so the shot was taken mid
transition and came out slightly different on every run.

Signed-off-by: Jason Madigan <jason@jasonmadigan.com>
@jasonmadigan
jasonmadigan marked this pull request as ready for review November 15, 2026 18:32
@jasonmadigan
jasonmadigan merged commit fff65f0 into main Nov 15, 2026
6 checks passed
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

0