Skip to content

Conversation

@ddzoan
Copy link
Contributor

@ddzoan ddzoan commented Dec 6, 2025

This adds a link to the apk files in the ImmichFrame_Android releases

Motivation

When I was setting up it up on my Frameo device, I didn't realize the releases were in a separate repo from ImmichFrame and spent more time looking for it than necessary. This should help people find it faster.

Summary by CodeRabbit

  • Documentation
    • Improved Android documentation links and cross-references for better navigation and consistency.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Dec 6, 2025

Walkthrough

Documentation updated to use consistent markdown cross-references for Android release links. The file docs/docs/getting-started/apps.md now references the centralized [github-android-releases] link definition instead of inline text labels, improving maintainability.

Changes

Cohort / File(s) Summary
Documentation link references
docs/docs/getting-started/apps.md
Updated Android and Frameo ADB sections to use [github-android-releases] cross-reference link definition instead of plain text labels

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

  • Verify the new [github-android-releases] link reference points to the correct URL
  • Confirm all references to Android releases now use the centralized link definition
  • Check that the Frameo ADB instructions remain accurate with the updated reference

Poem

🐰 Cross-references hop into place,
Markdown links find their base,
Android paths now unified,
One link rule applied,
Documentation feels the grace! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Add release link to frameo docs' accurately describes the main change: adding a release link reference to the Frameo documentation section.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7953786 and f8c1673.

📒 Files selected for processing (1)
  • docs/docs/getting-started/apps.md (3 hunks)
🔇 Additional comments (3)
docs/docs/getting-started/apps.md (3)

16-16: Great addition—helpful guidance for sideloading.

The Android section now clearly directs users to the APK releases for those who prefer or need to sideload, improving discoverability of the Android repository releases.


70-70: Well-targeted link for Frameo users.

The update to the Frameo ADB instructions now provides a direct link to the APK, making it easier for users to locate the necessary file without having to navigate separately. This directly addresses the PR objective of reducing friction for users installing on Frameo devices.


187-187: Link definition properly placed and formatted.

The new [github-android-releases] reference is correctly added to the link definitions section, following the existing alphabetical ordering and reference-link style. The URL points to the correct Android repository releases page.


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.

❤️ Share

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

Copy link
Contributor

@jfly jfly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would have saved me some time!

@3rob3
Copy link
Collaborator

3rob3 commented Dec 6, 2025

Nice, thanks!

@3rob3 3rob3 added the documentation Improvements or additions to documentation label Dec 6, 2025
@3rob3 3rob3 merged commit fe4493b into immichFrame:main Dec 6, 2025
6 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants