pandoras-box/monkey
8
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages 1 Wiki Activity Actions

docs: document pdf to-images/from-images, image diff, ImageMagick filters (MK-11) #31

Merged
nrupard merged 1 commit from chore/update-docs-MK-11 into main 2026-05-21 21:42:42 +02:00
Conversation 0 Commits 1 Files changed 1 +42 -7
nrupard commented 2026-05-21 21:34:22 +02:00
Member
Copy link

What

Bring the README up to date with commands that shipped but were never documented (MK-11).

  • Add monkey pdf to-images (rasterize PDF pages via pdftoppm) and monkey pdf from-images (bundle images into a PDF) sections.
  • Add a monkey image diff section (per-pixel image comparison).
  • Split the monkey image <filter> list into G'MIC-inspired and ImageMagick-inspired groups and add the six previously-undocumented ImageMagick filters: shave, deskew, colors, colorspace, contrast-stretch, density.
  • Note poppler-utils (pdftoppm) in both the runtime-image and static-binary install instructions, since pdf to-images needs it.

Why

The README documented only monkey pdf extract-images and 13 of the 19 image filters, and omitted image diff entirely. A reader could not discover half the PDF surface or the ImageMagick op set from the docs.

Scope

Documentation only. No code change; flag names, defaults, and enum values were verified against src/main.rs and src/image/mod.rs rather than guessed.

## What Bring the README up to date with commands that shipped but were never documented (MK-11). - Add `monkey pdf to-images` (rasterize PDF pages via `pdftoppm`) and `monkey pdf from-images` (bundle images into a PDF) sections. - Add a `monkey image diff` section (per-pixel image comparison). - Split the `monkey image <filter>` list into G'MIC-inspired and ImageMagick-inspired groups and add the six previously-undocumented ImageMagick filters: `shave`, `deskew`, `colors`, `colorspace`, `contrast-stretch`, `density`. - Note `poppler-utils` (`pdftoppm`) in both the runtime-image and static-binary install instructions, since `pdf to-images` needs it. ## Why The README documented only `monkey pdf extract-images` and 13 of the 19 image filters, and omitted `image diff` entirely. A reader could not discover half the PDF surface or the ImageMagick op set from the docs. ## Scope Documentation only. No code change; flag names, defaults, and enum values were verified against `src/main.rs` and `src/image/mod.rs` rather than guessed.
docs: document pdf to-images/from-images, image diff, ImageMagick filters (MK-11)
All checks were successful
Check / fmt + clippy + build + tests (pull_request) Successful in 17s
Details
Create release / Create release from merged PR (pull_request) Has been skipped
Details
d86bff19da 
README lagged behind shipped commands. Add the missing `monkey pdf to-images` and `monkey pdf from-images` sections, a `monkey image diff` section, and the six ImageMagick-inspired image filters (shave, deskew, colors, colorspace, contrast-stretch, density) that the filter list had omitted. Note that the runtime image and static-binary install instructions now mention `poppler-utils`, required by `pdf to-images`.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
nrupard deleted branch chore/update-docs-MK-11 2026-05-21 21:42:42 +02:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
pandoras-box/monkey!31
No description provided.