Major rewrite of the Frameo installation instructions#593
Major rewrite of the Frameo installation instructions#593Torstein-Eide wants to merge 5 commits intoimmichFrame:mainfrom
Conversation
📝 WalkthroughWalkthroughRewrote and expanded the Frameo and Frameo WebView instructions in Changes
Sequence Diagram(s)(omitted) Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 8
🤖 Fix all issues with AI agents
In `@docs/docs/getting-started/apps.md`:
- Line 223: The markdown image tag currently has no alt text for
Frameo_digital_photo_frames_webview.png; update the tag
 to include a concise, descriptive
alt string (for example: ) so screen readers and cases
where the image fails to load have meaningful text.
- Line 197: Replace the unhyphenated compound adjective "auto complete" with the
hyphenated form "auto-complete" in the sentence containing "`adb push
/path/to/webview.apk /sdcard/webview.apk`" (the line that currently reads
"Android does not have auto complete...") so the documentation uses the correct
compound adjective form.
- Line 133: The markdown image tag
"" is missing alt text; update
that image reference to include a descriptive alt string (for example "Frameo
digital photo frame default app") so screen readers and broken-image contexts
have meaningful text, i.e., modify the markdown image tag to include the alt
text between the brackets.
- Around line 182-184: The fenced code block containing the adb uninstall
command lacks a language identifier; update the block around the line "adb
uninstall com.immichframe.immichframe" to use a shell/bash language tag (e.g.,
```bash) so the snippet is syntax-highlighted and more readable in docs.
- Around line 82-88: Correct typographical errors in the Webview feature note:
change the heading sentence "Webview provieds the following features" to
"Webview provides the following features", change the list item "Video playback
(experimenta)" to "Video playback (experimental)", and change the trailing
"etc)" to "etc.)" so the feature list text is spelled and punctuated correctly.
- Around line 227-229: Fix the blockquote spacing in the fenced code block:
remove the extra spaces after the blockquote symbol on the lines that currently
read as quoted shell lines (the lines wrapping "```shell", "adb shell pm path
com.android.webview", and "```") so each line uses a single ">" followed
immediately by the content (i.e., change "> adb shell pm path
com.android.webview" to "> adb shell pm path com.android.webview" and similarly
for the surrounding fence lines).
- Line 138: Fix the inverted version comparison in the docs note: change the
parenthetical from "(< 1.29)" to "(>= 1.29)" or reword to say "in versions 1.29
and later" so the sentence correctly communicates that the feature is not
possible on newer releases and that uninstalling updates to 1.24 is required;
update the text fragment "This is not possible with latest app version (< 1.29)"
to the corrected comparison or phrasing.
- Around line 108-109: The PowerShell pipeline passes the .assets array to
Invoke-WebRequest instead of the APK download URL; extract the
browser_download_url first and pass that string to Invoke-WebRequest. Update the
invocation that uses Invoke-RestMethod, .assets, Where-Object and Select-Object
-ExpandProperty browser_download_url so the result (or a local $url variable) is
what you feed into Invoke-WebRequest -Uri, then call Invoke-WebRequest -OutFile
ImmichFrame.apk with that URL.
Updated instructions for setting ImmichFrame as the default HOME app and clarified the note regarding Frameo app updates.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/docs/getting-started/apps.md`:
- Around line 129-131: The numbered step 9 has inconsistent indentation in the
markdown; update the block containing "Set as default HOME app:" and the
following indented instruction line ("On first reboot after install you will be
asked to select default Launcher, select `ImmichFrame` and select \"Always\"")
so its indentation matches the other numbered steps (use the same two-space or
four-space indent pattern as steps above) to ensure the markdown list renders
correctly.
|
|
||
| 5. Download the latest ImmichFrame APK from the [GitHub Releases][github-android-releases] page to your PC. | ||
|
|
||
| For linux or mac you can run the following command to download the latest release directly to your current directory: |
There was a problem hiding this comment.
This step seems unnecessary. They are already here on a device, just download it from releases.
There was a problem hiding this comment.
You think about the curl and windows equivalent?
I love then i can get latest version directly in terminal without using the web browser, download being outside of current working directory, etc.
| curl -L -o ImmichFrame.apk $(curl -s https://api.github.com/repos/immichFrame/ImmichFrame_Android/releases/latest | grep "browser_download_url.*apk" | cut -d : -f 2,3 | tr -d \") | ||
| ``` | ||
|
|
||
| For windows you can run the following command in powershell to download the latest release directly to your current directory: |
There was a problem hiding this comment.
This step seems unnecessary. They are already here on a device, just download it from releases.
|
Please fix the issues identified by code rabbit also. |
Fixes based in AI review
There was a problem hiding this comment.
Actionable comments posted: 6
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/docs/getting-started/apps.md`:
- Around line 112-118: The install commands reference ImmichFrame_vXX.apk which
doesn't match the earlier download steps that save the artifact as
ImmichFrame.apk; update the two adb install examples in the block containing the
curl/PowerShell download steps to use ImmichFrame.apk (or alternatively add a
short clarifying note stating that ImmichFrame_vXX.apk applies only to manual
release downloads while the scripted downloads save as ImmichFrame.apk) so
filenames are consistent with the curl/PowerShell commands.
- Line 188: Replace the incorrect Android version string "6.01" with the
standard identifier "6.0.1" in the text fragment reading: This has been tested
and working on Android 6.01 10.1" Frameo devices.; update that sentence to read
"...Android 6.0.1 10.1\" Frameo devices." so the Android version uses the
correct dotted format.
- Around line 200-220: The guide drops users into an interactive root shell with
"adb shell su" but then runs a host command "adb reboot" without exiting; either
add an explicit "exit" step after the cp step (so the subsequent "adb reboot"
runs from the host) or change the reboot step to the in-shell command "reboot"
and mark it as "Reboot device (from within the root shell)"; also prepend a
brief note like "Run the following inside the root shell:" before steps that are
intended to execute inside the su session (steps that run cp, rm, mount, etc.),
and apply the same clarification to the Frameo setup step 10 to avoid mixed
shell/local-terminal confusion.
- Line 77: The sentence "Frameo digital photo frames are low powered and run a
very old Android version, so they cannot run the full WebView version of the app
(however most of the main features are still supported except SplitView)." uses
the compound modifier incorrectly; change "low powered" to the hyphenated form
"low-powered" in that sentence to correctly form the compound adjective.
- Around line 135-143: Fix the inconsistent list indentation for "Step 10"
(change the leading single space to match the two-space format used by other
steps) and remove the ambiguous mixed interactive/local command block by either
replacing the interactive adb shell sequence with a non-interactive invocation
(adb shell su -c 'pm disable net.frameo.frame' followed by adb reboot) or by
splitting into two clear fenced code blocks with an explicit note ("Inside the
root shell, run:" / "Then from your local terminal, run:") so commands intended
for the device (pm disable / pm enable) are separated from local commands (adb
reboot); apply the same fix to the "Re-enable Frameo" section referenced in the
comment.
- Around line 145-146: The NOTE block has inconsistent leading spacing: the
marker line uses "> [!NOTE]" but the following line begins with " > This..." (an
extra leading space). Edit docs/docs/getting-started/apps.md to remove the stray
space before the '>' on the paragraph line so it matches the marker line format
(both lines should start with "> "), ensuring the "[!NOTE]" block and its
content use consistent blockquote prefixes.
---
Duplicate comments:
In `@docs/docs/getting-started/apps.md`:
- Around line 181-183: The fenced code block containing the adb uninstall
command is missing a language tag (causing markdownlint MD040); update the block
delimiter from ``` to ```bash so the block becomes a bash code fence around the
line with adb uninstall com.immichframe.immichframe to resolve the warning and
ensure proper syntax highlighting in docs/docs/getting-started/apps.md.
| - Sideload ImmichFrame: | ||
| ImmichFrame can be run on inexpensive Frameo digital photo frames with some additional effort. You can typically find these for ~$40 USD. | ||
|
|
||
| Frameo digital photo frames are low powered and run a very old Android version, so they cannot run the full WebView version of the app (however most of the main features are still supported except SplitView). |
There was a problem hiding this comment.
Hyphenate the compound adjective low-powered.
"low powered" modifying "Android version" is a compound modifier and should be hyphenated.
📝 Proposed fix
-Frameo digital photo frames are low powered and run a very old Android version, so they cannot run the full WebView version of the app
+Frameo digital photo frames are low-powered and run a very old Android version, so they cannot run the full WebView version of the app📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Frameo digital photo frames are low powered and run a very old Android version, so they cannot run the full WebView version of the app (however most of the main features are still supported except SplitView). | |
| Frameo digital photo frames are low-powered and run a very old Android version, so they cannot run the full WebView version of the app (however most of the main features are still supported except SplitView). |
🧰 Tools
🪛 LanguageTool
[grammar] ~77-~77: Use a hyphen to join words.
Context: ...D. Frameo digital photo frames are low powered and run a very old Android versi...
(QB_NEW_EN_HYPHEN)
[style] ~77-~77: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...al photo frames are low powered and run a very old Android version, so they cannot run the...
(EN_WEAK_ADJECTIVE)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/docs/getting-started/apps.md` at line 77, The sentence "Frameo digital
photo frames are low powered and run a very old Android version, so they cannot
run the full WebView version of the app (however most of the main features are
still supported except SplitView)." uses the compound modifier incorrectly;
change "low powered" to the hyphenated form "low-powered" in that sentence to
correctly form the compound adjective.
| ```bash | ||
| adb install /path/to/ImmichFrame_vXX.apk | ||
| ``` | ||
|
|
||
| **Update/reinstall existing ImmichFrame:** | ||
| ```bash | ||
| adb install -r /path/to/ImmichFrame_vXX.apk |
There was a problem hiding this comment.
Filename in install command is inconsistent with what the download commands produce.
The curl and PowerShell commands in step 5 both save the file as ImmichFrame.apk, but step 6 references ImmichFrame_vXX.apk. Users following the earlier download steps will get an error because the path won't match.
📝 Proposed fix
6. Sideload ImmichFrame:
```bash
- adb install /path/to/ImmichFrame_vXX.apk
+ adb install ImmichFrame.apk
```
**Update/reinstall existing ImmichFrame:**
```bash
- adb install -r /path/to/ImmichFrame_vXX.apk
+ adb install -r ImmichFrame.apk
```Or add a clarifying note that ImmichFrame_vXX.apk is the filename for manual downloads from the releases page, while the download commands produce ImmichFrame.apk.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/docs/getting-started/apps.md` around lines 112 - 118, The install
commands reference ImmichFrame_vXX.apk which doesn't match the earlier download
steps that save the artifact as ImmichFrame.apk; update the two adb install
examples in the block containing the curl/PowerShell download steps to use
ImmichFrame.apk (or alternatively add a short clarifying note stating that
ImmichFrame_vXX.apk applies only to manual release downloads while the scripted
downloads save as ImmichFrame.apk) so filenames are consistent with the
curl/PowerShell commands.
| 10. Then disable the Frameo app to set ImmichFrame as only Home app: | ||
|
|
||
| ```bash | ||
| adb shell su | ||
| pm disable net.frameo.frame | ||
| exit | ||
| adb reboot | ||
| ``` | ||
| If this doesn't stick on reboot, repeat the commands but power cycle after exit command |
There was a problem hiding this comment.
Step 10 indentation is inconsistent and the mixed shell/local-terminal code block is ambiguous.
Two separate issues:
-
Indentation: Line 135 starts with one space (
10.) while all other steps use two spaces (1.–9.). This inconsistency can break markdown list rendering. -
Interactive-shell clarity: The code block mixes commands intended to be run inside the
adb shell suroot shell (pm disable,exit) with a command run from the local terminal afterwards (adb reboot), without visual distinction. Users who copy-paste the block wholesale may runpm disable net.frameo.framelocally rather than on the device.
📝 Proposed fixes
Fix 1 — Indentation:
- 10. Then disable the Frameo app to set ImmichFrame as only Home app:
+ 10. Then disable the Frameo app to set ImmichFrame as only Home app:Fix 2 — Use non-interactive adb shell invocation to avoid ambiguity:
- ```bash
- adb shell su
- pm disable net.frameo.frame
- exit
- adb reboot
- ```
+ ```bash
+ adb shell su -c 'pm disable net.frameo.frame'
+ adb reboot
+ ```Or keep the interactive form but split the blocks with an explicit note:
+ Enter the root shell:
```bash
adb shell su
+ ```
+ Inside the root shell, run:
+ ```bash
pm disable net.frameo.frame
exit
```
+ Then from your local terminal, reboot the device:
```bash
adb reboot
```The same pattern (interactive adb shell su block mixing device and local commands) also appears in the Re-enable Frameo section at lines 170–173.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/docs/getting-started/apps.md` around lines 135 - 143, Fix the
inconsistent list indentation for "Step 10" (change the leading single space to
match the two-space format used by other steps) and remove the ambiguous mixed
interactive/local command block by either replacing the interactive adb shell
sequence with a non-interactive invocation (adb shell su -c 'pm disable
net.frameo.frame' followed by adb reboot) or by splitting into two clear fenced
code blocks with an explicit note ("Inside the root shell, run:" / "Then from
your local terminal, run:") so commands intended for the device (pm disable / pm
enable) are separated from local commands (adb reboot); apply the same fix to
the "Re-enable Frameo" section referenced in the comment.
| > [!NOTE] | ||
| > This is not possible with Frameo app versions >= 1.29, so uninstalling updates (to 1.24) is required to get the overwriting of default home app to work. If you have already updated the Frameo app, you can uninstall updates by going to Android Settings-Apps-Frameo-Uninstall Updates. |
There was a problem hiding this comment.
Inconsistent leading space in the NOTE block.
Line 145 (> [!NOTE]) has no leading space, but line 146 ( > This is not possible…) has one leading space before >. While most renderers are tolerant, this is inconsistent with the NOTE block style used elsewhere in the file.
📝 Proposed fix
> [!NOTE]
-> This is not possible with Frameo app versions >= 1.29, so uninstalling updates...
+> This is not possible with Frameo app versions >= 1.29, so uninstalling updates...📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| > [!NOTE] | |
| > This is not possible with Frameo app versions >= 1.29, so uninstalling updates (to 1.24) is required to get the overwriting of default home app to work. If you have already updated the Frameo app, you can uninstall updates by going to Android Settings-Apps-Frameo-Uninstall Updates. | |
| > [!NOTE] | |
| > This is not possible with Frameo app versions >= 1.29, so uninstalling updates (to 1.24) is required to get the overwriting of default home app to work. If you have already updated the Frameo app, you can uninstall updates by going to Android Settings-Apps-Frameo-Uninstall Updates. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/docs/getting-started/apps.md` around lines 145 - 146, The NOTE block has
inconsistent leading spacing: the marker line uses "> [!NOTE]" but the following
line begins with " > This..." (an extra leading space). Edit
docs/docs/getting-started/apps.md to remove the stray space before the '>' on
the paragraph line so it matches the marker line format (both lines should start
with "> "), ensuring the "[!NOTE]" block and its content use consistent
blockquote prefixes.
| ``` | ||
| Follow instructions below to update WebView to 106. | ||
|
|
||
| This has been tested and working on Android 6.01 10.1" Frameo devices. |
There was a problem hiding this comment.
"6.01" is likely a typo for "6.0.1".
Android version 6 is formatted as 6.0 or 6.0.1; 6.01 is not a standard Android version identifier.
📝 Proposed fix
-This has been tested and working on Android 6.01 10.1" Frameo devices.
+This has been tested and working on Android 6.0.1 10.1" Frameo devices.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| This has been tested and working on Android 6.01 10.1" Frameo devices. | |
| This has been tested and working on Android 6.0.1 10.1" Frameo devices. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/docs/getting-started/apps.md` at line 188, Replace the incorrect Android
version string "6.01" with the standard identifier "6.0.1" in the text fragment
reading: This has been tested and working on Android 6.01 10.1" Frameo devices.;
update that sentence to read "...Android 6.0.1 10.1\" Frameo devices." so the
Android version uses the correct dotted format.
| 3. Enter shell and switch to the root user | ||
| ```shell | ||
| adb shell su | ||
| ``` | ||
| 4. Backup original WebView APK | ||
| ```shell | ||
| mount -o rw,remount /system && cp /system/app/webview/webview.apk /system/app/webview/webview.apk.bak | ||
| ``` | ||
| 5. Delete the oat folder recursively | ||
| ```shell | ||
| mount -o rw,remount /system && rm -rf /system/app/webview/oat | ||
| ``` | ||
| 6. Copy new WebView to system | ||
| ```shell | ||
| mount -o rw,remount /system && cp /sdcard/webview.apk /system/app/webview/webview.apk | ||
| ``` | ||
| 7. Reboot device | ||
| ```shell | ||
| adb reboot | ||
| ``` | ||
| After reboot, you should see a "installing new app" notification, and then you can verify the new WebView version by going to Android `Settings-Apps`, top right corner triple dot menu `show system`, Android System WebView. |
There was a problem hiding this comment.
Missing exit step causes step 7 (adb reboot) to fail for users following the guide sequentially.
Step 3 drops the user into an interactive root shell on the device (adb shell su). Steps 4–6 are commands run inside that root shell. Step 7 then instructs the user to run adb reboot, which is a local-terminal command — but the user is still inside the interactive device shell. Running adb reboot from within the adb shell will fail; the correct device command from inside the shell is reboot (no adb prefix).
The fix is either to add an explicit exit step, or change step 7 to use the in-shell reboot command.
📝 Option A — add an explicit `exit` step (preserves `adb reboot` in step 7)
6. Copy new WebView to system
```shell
mount -o rw,remount /system && cp /sdcard/webview.apk /system/app/webview/webview.apk
```
+7. Exit the root shell
+ ```shell
+ exit
+ ```
-7. Reboot device
+8. Reboot device
```shell
adb reboot
```📝 Option B — use in-shell `reboot` so no exit is needed
-7. Reboot device
- ```shell
- adb reboot
- ```
+7. Reboot device (from within the root shell)
+ ```shell
+ reboot
+ ```Note: this section also has the same mixed shell/local-terminal code block pattern flagged for the Frameo setup step 10 (lines 135–143) — steps 4–6 look like standalone terminal commands but are actually intended to be run inside the interactive root shell entered in step 3. Adding a brief note ("Run the following inside the root shell:") before each of steps 4–6 would significantly improve clarity.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/docs/getting-started/apps.md` around lines 200 - 220, The guide drops
users into an interactive root shell with "adb shell su" but then runs a host
command "adb reboot" without exiting; either add an explicit "exit" step after
the cp step (so the subsequent "adb reboot" runs from the host) or change the
reboot step to the in-shell command "reboot" and mark it as "Reboot device (from
within the root shell)"; also prepend a brief note like "Run the following
inside the root shell:" before steps that are intended to execute inside the su
session (steps that run cp, rm, mount, etc.), and apply the same clarification
to the Frameo setup step 10 to avoid mixed shell/local-terminal confusion.
2 participants
Major rewrite of the Frameo installation instructions
docs/docs/getting-started/apps.mdSummary by CodeRabbit