-
Notifications
You must be signed in to change notification settings - Fork 6
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.
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
Conversation
📝 WalkthroughWalkthroughDocumentation 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
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ 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. Comment |
There was a problem hiding this 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). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| 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").
Summary by CodeRabbit
Release Notes
✏️ Tip: You can customize this high-level summary in your review settings.