-
-
Notifications
You must be signed in to change notification settings - Fork 361
Update docs #3911
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
Update docs #3911
Conversation
|
Warning Rate limit exceeded@ildyria has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 8 minutes and 20 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis pull request updates README.md by introducing an upgrade notice for version 7.0, changing the Docker image reference from LycheeOrg/Lychee-Docker to LycheeOrg/Lychee, and adding HTML entity references to navigation links with minor wording adjustments throughout. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
Pre-merge checks✅ Passed checks (1 passed)
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: 2
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md
🧰 Additional context used
📓 Path-based instructions (1)
**/*.md
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
**/*.md: Use Markdown format for documentation
At the bottom of documentation files, add an hr line followed by "Last updated: [date of the update]"
Files:
README.md
🧠 Learnings (2)
📓 Common learnings
Learnt from: ildyria
Repo: LycheeOrg/Lychee PR: 3619
File: app/Rules/README.md:227-231
Timestamp: 2025-08-14T20:54:52.579Z
Learning: The user ildyria prefers to keep "Last updated" footers in italic format (*Last updated: [date]*) in documentation files, even if it triggers markdownlint MD036 warnings. This is a stylistic choice for the Lychee project.
Learnt from: ildyria
Repo: LycheeOrg/Lychee PR: 3765
File: version.md:1-1
Timestamp: 2025-10-26T19:15:58.151Z
Learning: The `version.md` file should NOT include the documentation footer (HR line followed by "*Last updated: [date]*") that is typically added to other Markdown files in the Lychee project. This file only contains the version number.
📚 Learning: 2025-10-26T19:15:58.151Z
Learnt from: ildyria
Repo: LycheeOrg/Lychee PR: 3765
File: version.md:1-1
Timestamp: 2025-10-26T19:15:58.151Z
Learning: The `version.md` file should NOT include the documentation footer (HR line followed by "*Last updated: [date]*") that is typically added to other Markdown files in the Lychee project. This file only contains the version number.
Applied to files:
README.md
🪛 LanguageTool
README.md
[grammar] ~57-~57: Ensure spelling is correct
Context: ...b.com/LycheeOrg/Lychee/releases to your webserver. If you feel like checking the authent...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🔇 Additional comments (1)
README.md (1)
73-73: Check spacing before the HTML entity on line 73.Line 73 appears to have extra whitespace between "Installation" and the
»entity ("Installation »" with what looks like two spaces). Verify if this is intentional or should be reduced to a single space for consistency with other navigation links in the file.
| ### Docker deployment | ||
|
|
||
| An official Docker image can be found at [LycheeOrg/Lychee-Docker](https://github.com/LycheeOrg/Lychee-Docker) or on Docker Hub as [lycheeorg/lychee](https://hub.docker.com/r/lycheeorg/lychee). | ||
| An official Docker image can be found at [LycheeOrg/Lychee](https://github.com/LycheeOrg/Lychee-Docker/pkgs/container/lychee) or on Docker Hub as [lycheeorg/lychee](https://hub.docker.com/r/lycheeorg/lychee). |
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.
Update Docker repository URL to match the new image reference.
The Docker image reference was updated from LycheeOrg/Lychee-Docker to LycheeOrg/Lychee on line 53, but the container registry URL still points to the old repository path (/LycheeOrg/Lychee-Docker/pkgs/container/lychee). Ensure consistency between the image name and its repository URL.
🔎 Proposed fix
-An official Docker image can be found at [LycheeOrg/Lychee](https://github.com/LycheeOrg/Lychee-Docker/pkgs/container/lychee) or on Docker Hub as [lycheeorg/lychee](https://hub.docker.com/r/lycheeorg/lychee).
+An official Docker image can be found at [LycheeOrg/Lychee](https://github.com/LycheeOrg/Lychee/pkgs/container/lychee) or on Docker Hub as [lycheeorg/lychee](https://hub.docker.com/r/lycheeorg/lychee).📝 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.
| An official Docker image can be found at [LycheeOrg/Lychee](https://github.com/LycheeOrg/Lychee-Docker/pkgs/container/lychee) or on Docker Hub as [lycheeorg/lychee](https://hub.docker.com/r/lycheeorg/lychee). | |
| An official Docker image can be found at [LycheeOrg/Lychee](https://github.com/LycheeOrg/Lychee/pkgs/container/lychee) or on Docker Hub as [lycheeorg/lychee](https://hub.docker.com/r/lycheeorg/lychee). |
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.