Skip to content

Update documentation links in README.md #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
3rob3 merged 1 commit into from
Jan 28, 2026
Merged

Update documentation links in README.md #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@
Desktop application that runs <a href="https://github.com/immichFrame/ImmichFrame">ImmichFrame</a> fullscreen.
<br />
<br />
<a href="https://immichframe.online/docs/getting-started/apps#desktop-windows-macos-linux">Documentation</a>
<a href="https://immichframe.dev">Documentation</a>
<p>
</div>

## 📄 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

@coderabbitai coderabbitai bot Jan 28, 2026

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").


# Development

Expand Down