Skip to content

fix: restore README screenshots and localize image read errors - #62

Merged
EtienneLescot merged 2 commits into
getopenscreen:mainfrom
Tamsi:fix/readme-screenshots-and-i18n
Jul 4, 2026
Merged

fix: restore README screenshots and localize image read errors#62
EtienneLescot merged 2 commits into
getopenscreen:mainfrom
Tamsi:fix/readme-screenshots-and-i18n

Conversation

@Tamsi

@Tamsi Tamsi commented Jul 1, 2026

Copy link
Copy Markdown

Summary

Small fixes for README rendering and a hardcoded UI string.

Changes

README

  • Restore screenshot image height (320px instead of 0.2467, which made demo images nearly invisible on GitHub)
  • Align macOS permission instructions with System Settings > Privacy & Security (Ventura+), matching the note above it

i18n

  • Use the existing settings.imageUpload.errorReading translation in AnnotationSettingsPanel instead of a hardcoded English error message (already used in SettingsPanel)

Test plan

  • README renders correctly on GitHub (screenshots visible)
  • Trigger an image upload read error in annotations — toast shows localized message

Context

Originally prepared against the archived upstream (siddharthvaddem/openscreen), which no longer accepts PRs. Retargeted to this active continuation fork.

Summary by CodeRabbit

  • Documentation
    • Updated the README with clearer macOS permission instructions and refreshed demo image sizing.
  • Bug Fixes
    • Improved image upload error messaging so it now uses the app’s localized text instead of a fixed English message.

- Restore demo screenshot height to 320px (0.2467 made images invisible)
- Align macOS permission instructions with System Settings naming
- Reuse settings.imageUpload.errorReading in AnnotationSettingsPanel
@Tamsi
Tamsi requested a review from EtienneLescot as a code owner July 1, 2026 16:34
@coderabbitai

coderabbitai Bot commented Jul 1, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: a02b9d9f-3728-4ae4-9b75-43bc66c0c5cf

📥 Commits

Reviewing files that changed from the base of the PR and between 2fc116b and a282225.

📒 Files selected for processing (2)
  • README.md
  • src/components/video-editor/AnnotationSettingsPanel.tsx

📝 Walkthrough

Walkthrough

This PR updates README image styling (fixed 320px height) and macOS permissions instructions (System Settings > Privacy & Security), plus localizes a hard-coded error message in AnnotationSettingsPanel.tsx to use an i18n translation key.

Changes

README Documentation Updates

Layer / File(s) Summary
Image styling and macOS instructions
README.md
Demo image inline styles changed to fixed height: 320px, and macOS permission instructions updated to reference System Settings > Privacy & Security.

Annotation Panel Localization

Layer / File(s) Summary
Localized error message
src/components/video-editor/AnnotationSettingsPanel.tsx
FileReader error toast description switched from hard-coded English text to t("imageUpload.errorReading").

Estimated code review effort: 1 (Trivial) | ~3 minutes

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description covers the summary and testing, but it omits several required template sections and the issue reference. Add the missing Related issue, Type of change, Release impact, Desktop impact, and Screenshots/video sections, and keep Testing as a checklist.
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main changes: README screenshot fix and localized image read errors.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@EtienneLescot EtienneLescot self-assigned this Jul 4, 2026
@EtienneLescot
EtienneLescot merged commit 2c1e036 into getopenscreen:main Jul 4, 2026
10 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.

2 participants