Skip to content

docs: illustrate current Readest Sync workflows - #36

Merged
42lizard merged 1 commit into
mainfrom
docs/current-features-screenshots
Sep 26, 2026
Merged

42lizard merged 1 commit into
mainfrom
docs/current-features-screenshots

Conversation

@42lizard

Copy link
Copy Markdown
Owner

Summary

Document the current library, reading-position and bidirectional annotation workflows, replacing outdated migration, tile-layout and startup-scan descriptions.

Readest Sync documentation
├── Illustrated user guide: five Mock cloud screenshots
├── Technical and installation guides: current behavior and limits
└── Simulator guide: reproducible screenshot capture

The images use isolated synthetic fixtures and retain the Simulator · Mock label. The reader panel is explicitly identified as a simulator aid. An optional READEST_DOC_SCREENSHOTS mode in the existing integration test reproduces the captures without changing the app or interactive profile.

Evidence

  • Before: README described pending Qt migration acceptance, library tiles and no startup scan; no illustrated guide or annotation workflow.
    After: User guide covers the current interface, downloads/uploads, position choices, highlights/notes and device limitations. All five 1404 × 1800 screenshots were visually checked.
  • Before: Screenshot capture had no dedicated documentation checkpoints.
    After: Simulator integration test passes with capture enabled (10.83 s) and disabled (9.23 s). All local documentation/image links and git diff --check pass.

Merge Danger

Door: two-way

Documentation and optional test-only capture changes; no application behavior or persisted formats change.

Blast Radius: documentation

@42lizard
42lizard merged commit 60509aa into main Sep 26, 2026
2 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