diff --git a/AGENTS.md b/AGENTS.md index 786dcba..7adcb26 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -6,6 +6,10 @@ manual and build tooling. It must build without a sibling beffroi-tools checkout Keep the single-member workspace and adapter design simple; avoid speculative layers of abstraction. User instructions take precedence over this guidance. +When resuming the migrated conversation, read `docs/development/handoff.md` for +pending decisions, video plans, prior test authorization and publication state. +Treat dated observations as a snapshot and verify current state before acting. + ## Project map - `crates/canvas-pilot/src/`: editor and application. `lib.rs`, `project.rs`, diff --git a/docs/canvas-pilot/changelog.md b/docs/canvas-pilot/changelog.md index 728c993..e6adbf8 100644 --- a/docs/canvas-pilot/changelog.md +++ b/docs/canvas-pilot/changelog.md @@ -4,6 +4,13 @@ ## Unreleased +- Saved a conversation handoff for reopening the standalone project, including + pending input-ratio scope, planned videos, device-test context and publication + state. Linked it from agent/developer guidance and retained pending plans in + the task list without changing completed acceptance status. Added the approved + showcase, video walkthrough and optional chapter clips as a stretch goal. + + - Redesigned the repository README with an illustrated introduction, layout workflow, feature overview, format/device guidance and direct setup, template and help links. Existing screenshots are identified as captures from before the rename. diff --git a/docs/canvas-pilot/plan.md b/docs/canvas-pilot/plan.md index b4db75b..1f51543 100644 --- a/docs/canvas-pilot/plan.md +++ b/docs/canvas-pilot/plan.md @@ -71,6 +71,11 @@ device readback and physical-screen acceptance. ## To-do list +- [ ] **Resolve local input-ratio correction scope.** Shared-input Content ratio + and Transform to controls already exist and are [documented](guide/formats-and-crop.md#content-ratio-versus-transform-to). + Whether to add a local correction/preview model remains an unanswered question; + do not treat a new implementation or persistence change as decided. + - [x] **Explicit Midra layer aspect modes.** 1:1, Centered, Fullscreen and Cropped are available behind **Layer properties → Crop → Advanced layer fit**. Crop-first math, centered placement, clipping, import/send, preview and project @@ -83,6 +88,17 @@ device readback and physical-screen acceptance. ### Stretch goals (distant future) +- [ ] **Video showcase, manual and optional chapter demonstrations.** Record a + short showcase for the README and book introduction, then a guided video manual + linked from quick start with chapter timestamps. Use the existing + [feature demonstration checklist](feature-demo-checklist.md) as the recording + outline. Add short chapter clips where motion helps: crop controls, 1:1 crop + movement, masks and device mapping/transfers; start with the two main videos. + Keep written instructions as the searchable reference. Include captions and the + recorded application version, avoid autoplay, and host large video files outside + Git. Link or embed them in the book once a host is chosen. This approach is + user-approved; recording, hosting choice and implementation remain future work. + - [ ] **Confirm Midra fit precision with a manufacturer/firmware engineer.** Obtain crop quantization, subpixel centering and rasterization rules, plus expected results for asymmetric crops and odd container dimensions. Use the diff --git a/docs/development/README.md b/docs/development/README.md index f579954..af8ff50 100644 --- a/docs/development/README.md +++ b/docs/development/README.md @@ -12,3 +12,6 @@ for remaining work and hardware validation. Device writes are never CI tests. See [the documentation index](../README.md) for every planning and acceptance record, and [AGENTS.md](../../AGENTS.md) for repository working conventions. + +[Conversation handoff](handoff.md) preserves pending decisions, video plans and +the migration/publication state for the next session. diff --git a/docs/development/handoff.md b/docs/development/handoff.md new file mode 100644 index 0000000..918accb --- /dev/null +++ b/docs/development/handoff.md @@ -0,0 +1,134 @@ +# Conversation handoff — 2026-11-16 + +Read this when resuming work in the standalone Canvas Pilot repository. This is a +snapshot of conversation context, not a replacement for the current code, Git status, +[plan](../canvas-pilot/plan.md), [contracts](../interfaces/README.md) or +[AGENTS.md](../../AGENTS.md). Recheck status before acting on dated information. + +## Where work stands + +The migration and README redesign are complete. The user is reopening the +conversation in this project; no additional feature implementation is currently +underway. Application behavior was preserved during extraction. + +- Local project: `/home/beffroi/Documents/Git/canvas-pilot`. +- Original project: sibling `../beffroi-tools`. +- Gitea: https://proxy.dandaedre.com/gitea/idle-org/canvas-pilot +- Public book: https://books.dandaedre.com/manuals/canvas-pilot/ +- All 165 project-owned files were audited against the pre-migration source commit. + See [migration provenance and inventory](migration.md). +- `AGENTS.md` contains repository conventions and a project/documentation map. + [The documentation index](../README.md) links the advanced guide, task/test lists, + stretch goals, engineer questions, adapter research and demonstration script. + +## Git and publication state at handoff + +The migration commit `4eef1bc` was pushed and verified on Gitea. Follow-up commits +`a595838` (audit/agent guidance) and `b2fcab4` (README redesign) were committed locally +but not pushed. This handoff is another local commit. Check +`git log origin/main..HEAD` and fetch when appropriate rather than assuming this +snapshot is still current. Do not push without a user request. + +The original repository's extraction/link commit is `7b91ede`, committed locally +and not pushed. Its working tree was clean at the last check. + +The Gitea repository description and avatar were updated through the API and +verified. The avatar is `crates/canvas-pilot/assets/app-icon.png`. The description +explains desktop layout editing, offline work and Midra/Aquilon geometry transfers. +These settings are server-side; they do not require a Git commit. + +The new Jenkins job hookup has not been performed in this conversation. Setup is +in [CI](ci.md). The three new badge URLs returned HTTP 404 at the last check; +the README therefore keeps them in a collapsed Build status section pending the +first publication. No new book deployment was performed during migration. +Canvas Pilot publishes only its own book and badges; beffroi-tools retains ownership +of the shared manuals landing page. Never synchronize/delete that shared root. + +A user-provided Gitea token remains at `../gitea-token.txt` on this workstation, +outside both repositories. It was successfully used for repository settings and +avatar upload. Do not copy or display it. Repository API operations worked; querying +`/api/v1/user` returned 403, so account-profile access must not be assumed. Gitea's +own `/swagger.v1.json` documents the API, including base64 repository-avatar upload. + +## Decisions and preferences to retain + +- The name is **Canvas Pilot**. It is independent software, not affiliated with + Analog Way. Keep existing settings paths and serialized Midra identifiers compatible. +- Adapters should be first-class and practical, with a shared intermediate geometry + representation and isolated family-specific behavior. Avoid abstraction for its + own sake. Preserve targeted reads and partial writes for performance. +- Aquilon support is completed for the documented standalone AQL Cmax 6.2.x profile; + do not reopen the completed task or extend its claim to untested configurations. +- Multiple editor screens are a distant stretch goal: a dropdown selects one screen + at a time. Other adapters need protocol documentation and a usable emulator before + development. Their ranking is research, not a promised release schedule. +- Export cleanup was explicitly marked solved. Saving a captured input as a separate + image was removed from the backlog at the user's request; do not restore that task. +- The operator cannot perform exact pixel/subpixel measurements. Keep precision and + mask-rasterization questions in the engineer-facing stretch goal; do not make those + measurements a prerequisite for ordinary operator acceptance. +- Explicit layer aspect modes take precedence over shared input fill. Crop is applied + first; 1:1 uses centered native pixels, Fullscreen stretches, Centered fits inside, + and Cropped fills/clips. Advanced fit stays behind an opt-in control. Existing + helpers support the intended crop/move interactions, and masking uses a separate + magenta box. Consult the code and guide before altering their behavior. + +## Pending input-ratio scope + +The user described correcting a stretched/deformed input, usually left on Native, +with preset or custom ratios. Manual research established the distinction between +**Content ratio** and **Transform to**; the result is already recorded in +[Formats and crop](../canvas-pilot/guide/formats-and-crop.md#content-ratio-versus-transform-to). +Advanced device controls already exist. A follow-up question about adding a **local +editor correction/preview model** was not answered before the migration. +Do not treat this as an implemented feature or a finalized new schema. Resume from +the documented distinction and clarify the desired local behavior when that work +is taken up; preserve the input-agnostic editing workflow and opt-in shared writes. + +## Video plans + +The user plans a **showcase video** and a **video manual**, and asked whether videos +also belong in the book. No videos, hosting choice or embed implementation exist yet. +The [feature demonstration checklist](../canvas-pilot/feature-demo-checklist.md) +already supplies an ordered recording script. + +The user approved the following approach and asked to put it in the stretch goals: + +- Showcase near the top of the README and book introduction. +- A walkthrough linked from quick start, with chapter timestamps. +- Optional short demonstrations beside difficult interactions: crop, 1:1 movement, + masks and device mapping/transfers. Start with the two main videos first. +- Written instructions remain the searchable reference; captions, no autoplay, and + the application version help viewers. Host large video files outside Git and link + or embed them once a host is chosen. + +The existing screenshots are real captures from before the Canvas Pilot rename; +the redesigned README explicitly labels them. Their recipes and provenance are in +[the screenshot guide](../canvas-pilot/images/README.md). Do not edit old screenshots +to imply a new capture; recapture the application if updating them. + +## Device testing context + +The user explicitly authorized testing and writes on the emulator at +`192.168.10.146:3000` and later said it was online again. At the last recorded work +it was an Aquilon emulator; AWJ TCP 10606 was also needed. This is historical scope, +not evidence that the endpoint is online or unchanged today. Discover identity +before writing, preserve/restore the baseline, and keep emulator results distinct +from physical-output acceptance. + +The physical Midra at `192.168.10.143:80` was used read-only in the recent work; +the emulator authorization does not extend to that device. No device connection +is needed for repository, documentation or routine automated tests. + +## Last validation evidence + +The extraction passed formatting, both Clippy feature configurations, rustdoc, +Python tests and Rust tests. Canvas Pilot had 395 passing default-feature tests and +390 in each restricted configuration; the remaining workspace had 149 Rust tests. +Measured line coverage was 91.03% for Canvas Pilot and 89.83% for beffroi-tools +against a 75% floor. These are historical measurements, not live CI badges. + +The expanded book built with pinned mdBook 0.5.4 and validated 41 pages and 1,826 +local links/assets. The README was rendered locally and visually inspected; +local links and badge tests passed. Subsequent documentation edits should rebuild +the book; code changes need the relevant checks in [CI](ci.md).