Skip to content

Conversation

@3rob3
Copy link
Contributor

@3rob3 3rob3 commented Jan 28, 2026

Summary by CodeRabbit

Release Notes

  • Documentation
    • Updated documentation links in README to direct to the new documentation portal at immichframe.dev, consolidating all platform-specific resources for improved accessibility.

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

@coderabbitai
Copy link

coderabbitai bot commented Jan 28, 2026

📝 Walkthrough

Walkthrough

Documentation links in README.md were updated to point to https://immichframe.dev instead of the previous https://immichframe.online/docs/getting-started/apps#desktop-windows-macos-linux endpoint, affecting both the header navigation and the Documentation section.

Changes

Cohort / File(s) Summary
Documentation Updates
README.md
Updated documentation links in header and Documentation section to reference new domain (https://immichframe.dev)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A link, a hop, a simple fix,
New docs await at dev's mix,
The rabbit nods with glee so bright—
URLs updated, navigation's right! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title accurately describes the main change: updating documentation links in README.md.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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.

@3rob3 3rob3 added the documentation Improvements or additions to documentation label Jan 28, 2026
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@README.md`:
- Line 17: Replace the non-descriptive link text "here" with a descriptive
phrase like "ImmichFrame documentation" or "ImmichFrame docs" in the README line
that currently reads "You can find the documentation
[here](https://immichframe.dev)" so the link text is meaningful and satisfies
MD059 (e.g., "You can find the ImmichFrame documentation at
https://immichframe.dev").


## 📄 Documentation
You can find the documentation [here](https://immichframe.online/docs/getting-started/apps#desktop-windows-macos-linux).
You can find the documentation [here](https://immichframe.dev).
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Use descriptive link text instead of “here”.

Improves readability and satisfies MD059.

✅ Suggested wording
-You can find the documentation [here](https://immichframe.dev).
+You can find the documentation on the [ImmichFrame documentation site](https://immichframe.dev).
📝 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.

Suggested change
You can find the documentation [here](https://immichframe.dev).
You can find the documentation on the [ImmichFrame documentation site](https://immichframe.dev).
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

17-17: Link text should be descriptive

(MD059, descriptive-link-text)

🤖 Prompt for AI Agents
In `@README.md` at line 17, Replace the non-descriptive link text "here" with a
descriptive phrase like "ImmichFrame documentation" or "ImmichFrame docs" in the
README line that currently reads "You can find the documentation
[here](https://immichframe.dev)" so the link text is meaningful and satisfies
MD059 (e.g., "You can find the ImmichFrame documentation at
https://immichframe.dev").

@3rob3 3rob3 merged commit 71fc2fd into main Jan 28, 2026
2 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.

2 participants