docs: add top-level Workflow section to README (MK-21) #37

Merged

David merged 1 commit from docs/readme-workflow-MK-21 into main

2026-05-24 19:41:38 +02:00

David commented

2026-05-24 19:37:38 +02:00

Owner

Implements MK-21.

Summary

Adds a top-level ## Workflow section between Install and Commands.
Walks the canonical three-step loop: monkey image auto --record, monkey image rate, iterate.
Pins ~/.local/share/monkey/runs.jsonl as the stable XDG log location for the canonical example. Per-command examples below it continue to use the relative runs.jsonl filename (those examples document the flag, not the convention).
Three relative-anchor links from the new section into the existing per-command reference.

Reformat note

The diff also carries an editor-driven reformat of pre-existing prose: long single-line paragraphs are hard-wrapped to ~120 columns and the video-format table's border syntax is tightened. That reformat was sitting in the working tree before this change and lands here per direct user instruction to bundle it into the same PR.

Test plan

just check (fmt + clippy + build + Docker stage).
Visual check of the rendered Markdown for anchor link correctness.
Forgejo CI on this PR.

Implements MK-21. ## Summary - Adds a top-level `## Workflow` section between Install and Commands. - Walks the canonical three-step loop: `monkey image auto --record`, `monkey image rate`, iterate. - Pins `~/.local/share/monkey/runs.jsonl` as the stable XDG log location for the canonical example. Per-command examples below it continue to use the relative `runs.jsonl` filename (those examples document the flag, not the convention). - Three relative-anchor links from the new section into the existing per-command reference. ## Reformat note The diff also carries an editor-driven reformat of pre-existing prose: long single-line paragraphs are hard-wrapped to ~120 columns and the video-format table's border syntax is tightened. That reformat was sitting in the working tree before this change and lands here per direct user instruction to bundle it into the same PR. ## Test plan - [x] `just check` (fmt + clippy + build + Docker stage). - [x] Visual check of the rendered Markdown for anchor link correctness. - [ ] Forgejo CI on this PR.

David added 1 commit

2026-05-24 19:37:38 +02:00

docs: add top-level Workflow section showing the auto -> rate loop

Check / fmt + clippy + build + tests (pull_request) Successful in 18s

Details

Create release / Create release from merged PR (pull_request) Has been skipped

Details

c9c9c2dce5

A reader new to monkey skims the README from the top and currently has no signpost that `monkey image classify`, `monkey image auto`, and the `--record` / `monkey image rate` feedback log compose into a single canonical loop. They are each documented in isolation under their own subsections of the per-command reference, which works as a manual page but hides the workflow the project was built around.

This adds a `## Workflow` section between Install and Commands that walks the three-step loop (process, score, iterate) using the XDG-stable `~/.local/share/monkey/runs.jsonl` path as the recorded-log convention. The per-command reference is untouched and continues to use the relative `runs.jsonl` filename in its examples, which documents the flag rather than the canonical convention.

The diff also carries an editor-driven reformat of pre-existing prose: long single-line paragraphs are hard-wrapped to ~120 columns and the video-format table's border syntax is tightened. That reformat was sitting in the working tree before this change and lands here per direct user instruction to bundle it into the same PR; the new Workflow content is the focus of the commit.

#MK-21 State Done

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>