Skip to content

Conversation

@ildyria
Copy link
Member

@ildyria ildyria commented Dec 30, 2025

Summary by CodeRabbit

  • Documentation
    • Added an upgrade notice for Version 7.0 with Docker image changes guidance
    • Updated Docker image reference for deployment instructions
    • Enhanced link formatting and clarity in installation documentation

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

@ildyria ildyria requested a review from a team as a code owner December 30, 2025 23:40
@coderabbitai
Copy link

coderabbitai bot commented Dec 30, 2025

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

📥 Commits

Reviewing files that changed from the base of the PR and between 364248d and 28aa401.

📒 Files selected for processing (1)
  • README.md
📝 Walkthrough

Walkthrough

This 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

Cohort / File(s) Summary
Documentation Updates
README.md
Added "Upgrade Notice to Version 7.0" section; updated Docker image reference (LycheeOrg/Lychee-Docker → LycheeOrg/Lychee); added HTML entity references (») to link labels; minor wording adjustments to installation and deployment instructions

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A notice bounced through the docs today,
Docker names got a fresh update, hooray!
Links now shimmer with HTML grace,
Version seven takes its rightful place!
📚✨

Pre-merge checks

✅ Passed checks (1 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

@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: 2

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bf38642 and 364248d.

📒 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).
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

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.

Suggested change
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).

@ildyria ildyria closed this Dec 31, 2025
@ildyria ildyria deleted the docs branch December 31, 2025 03:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants