Conversation
WalkthroughDocumentation version references updated from 4.5 to 5.0 across installation and method links in README files. Additional explanatory bullets added for Developer Formatting hooks and CI/Cirrus workflow dependencies in English documentation. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes
Possibly related PRs
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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 |
|
fix Issue#896 |
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
README.md(1 hunks)README_CN.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
- GitHub Check: oracle_regression (ubuntu-latest)
- GitHub Check: build (ubuntu-latest)
- GitHub Check: contrib_regression
- GitHub Check: pg_regression (ubuntu-latest)
- GitHub Check: oracle_pg_regression (ubuntu-latest)
- GitHub Check: meson_build (ubuntu-latest)
🔇 Additional comments (2)
README_CN.md (1)
1-37: Localization inconsistency: Chinese README missing Developer Formatting section.README.md includes a new "Developer Formatting hooks and CI" section (lines 34-37) explaining the pre-commit hook setup, in-tree tool dependencies, and Cirrus FormatCheck workflow. This section is not present in the Chinese README_CN.md. Please clarify if this section should be added to README_CN.md for consistency, or if this omission is intentional.
README.md (1)
34-37: Well-documented developer tooling guidance.The new "Developer Formatting hooks and CI" section clearly explains the pre-commit hook setup, in-tree tool dependencies, and the Cirrus FormatCheck workflow. This is a helpful addition to the README.
| 建议参考[快速入门](https://docs.ivorysql.org/cn/ivorysql-doc/v5.0/v5.0/3#quick-installation)了解如何安装和运行IvorySQL。 | ||
|
|
||
| 此外，关于更详细的安装说明，请参阅[安装文档](https://docs.ivorysql.org/cn/ivorysql-doc/v4.5/v4.5/6#introduction)。我们提供以下四种 IvorySQL 的安装方法： | ||
| - [Yum 安装](https://docs.ivorysql.org/cn/ivorysql-doc/v4.5/v4.5/6#yum源安装) | ||
| - [Docker 安装](https://docs.ivorysql.org/cn/ivorysql-doc/v4.5/v4.5/6#docker安装) | ||
| - [RPM 安装](https://docs.ivorysql.org/cn/ivorysql-doc/v4.5/v4.5/6#rpm安装) | ||
| - [源代码安装](https://docs.ivorysql.org/cn/ivorysql-doc/v4.5/v4.5/6#源码安装) | ||
| 此外，关于更详细的安装说明，请参阅[安装文档](https://docs.ivorysql.org/cn/ivorysql-doc/v5.0/v5.0/6#introduction)。我们提供以下四种 IvorySQL 的安装方法： | ||
| - [Yum 安装](https://docs.ivorysql.org/cn/ivorysql-doc/v5.0/v5.0/6#yum源安装) | ||
| - [Docker 安装](https://docs.ivorysql.org/cn/ivorysql-doc/v5.0/v5.0/6#docker安装) | ||
| - [RPM 安装](https://docs.ivorysql.org/cn/ivorysql-doc/v5.0/v5.0/6#rpm安装) | ||
| - [源代码安装](https://docs.ivorysql.org/cn/ivorysql-doc/v5.0/v5.0/6#源码安装) |
There was a problem hiding this comment.
🧩 Analysis chain
Verify v5.0 documentation links are valid and anchors match actual documentation.
Version references have been updated from 4.5 to 5.0, but the documentation links should be validated to ensure they resolve correctly and the anchor fragments (#quick-installation, #introduction, #yum源安装, etc.) match the actual section identifiers in the v5.0 documentation.
🌐 Web query:
Are the IvorySQL v5.0 documentation pages available at docs.ivorysql.org/cn/ivorysql-doc/v5.0?
💡 Result:
No. As of November 14, 2025 the URL https://docs.ivorysql.org/cn/ivorysql-doc/v5.0/ returns 404 (not found), and the docs site currently shows master and earlier version pages (e.g. v4.x). [1][2]
Sources:
[1] IvorySQL Chinese docs (master).
[2] HTTP 404 response for /cn/ivorysql-doc/v5.0/.
Critical: Documentation links in README_CN.md point to non-existent v5.0 documentation.
The v5.0 documentation at docs.ivorysql.org/cn/ivorysql-doc/v5.0/ returns 404 (not found). The documentation currently available is only master and v4.x versions. All four documentation links in lines 30-36 (Quick Start, Installation Docs, and the four installation methods) are broken and will fail to resolve for users.
This requires updating the version references back to a working documentation version (likely v4.x) until v5.0 documentation is officially published.
🤖 Prompt for AI Agents
In README_CN.md around lines 30 to 36, the documentation links reference the
non-existent v5.0 docs and return 404; update all five URLs (Quick Start,
Installation overview, and the four install-method links) to point to a working
version (e.g., replace "/v5.0/" with "/v4.x/" or "/master/" in each URL) so they
resolve, and run a quick link check to ensure the new targets return 200.
| We recommend following our [Quick Start](https://docs.ivorysql.org/en/ivorysql-doc/v5.0/v5.0/3#quick-installation) for how to install and running IvorySQL. | ||
|
|
||
| Furthermore, for more detailed installation instructions, please refer to the [Installation Docs](https://docs.ivorysql.org/en/ivorysql-doc/v4.5/v4.5/6#introduction). We provide four installation methods for IvorySQL, as outlined below: | ||
| - [Yum installation](https://docs.ivorysql.org/en/ivorysql-doc/v4.5/v4.5/6#Yum-installation) | ||
| - [Docker installation](https://docs.ivorysql.org/en/ivorysql-doc/v4.5/v4.5/6#Docker-installation) | ||
| - [Rpm installation](https://docs.ivorysql.org/en/ivorysql-doc/v4.5/v4.5/6#Rpm-installation) | ||
| - [Source code installation](https://docs.ivorysql.org/en/ivorysql-doc/v4.5/v4.5/6#Source-code-installation) | ||
| Furthermore, for more detailed installation instructions, please refer to the [Installation Docs](https://docs.ivorysql.org/en/ivorysql-doc/v5.0/v5.0/6#introduction). We provide four installation methods for IvorySQL, as outlined below: | ||
| - [Yum installation](https://docs.ivorysql.org/en/ivorysql-doc/v5.0/v5.0/6#Yum-installation) | ||
| - [Docker installation](https://docs.ivorysql.org/en/ivorysql-doc/v5.0/v5.0/6#Docker-installation) | ||
| - [Rpm installation](https://docs.ivorysql.org/en/ivorysql-doc/v5.0/v5.0/6#Rpm-installation) | ||
| - [Source code installation](https://docs.ivorysql.org/en/ivorysql-doc/v5.0/v5.0/6#Source-code-installation) |
There was a problem hiding this comment.
🧩 Analysis chain
Verify v5.0 documentation links are valid and English anchors match actual documentation.
Version references updated from 4.5 to 5.0. Confirm the documentation links are accessible and the English anchor fragments (#Yum-installation, #Docker-installation, #Rpm-installation, #Source-code-installation) match actual section identifiers in the v5.0 documentation.
🌐 Web query:
Are the IvorySQL v5.0 documentation pages available at docs.ivorysql.org/en/ivorysql-doc/v5.0?
💡 Result:
No. The URL https://docs.ivorysql.org/en/ivorysql-doc/v5.0 returns a 404 (not found). [1] The IvorySQL docs site does host v4.x pages (e.g. v4.4), but not a v5.0 directory at that location. [2]
Sources:
[1] docs.ivorysql.org/en/ivorysql-doc/v5.0 (404).
[2] docs.ivorysql.org/en/ivorysql-doc/v4.4 (IvorySQL v4.4 documentation).
Remove v5.0 documentation links or update to use latest available version (v4.4).
The v5.0 documentation is not yet available at docs.ivorysql.org/en/ivorysql-doc/v5.0 (returns 404). All four installation method links (lines 26-32) point to non-existent v5.0 documentation and will be broken for users. Either revert to the latest available version (v4.4) or remove these links until v5.0 documentation is published.
🤖 Prompt for AI Agents
README.md lines 26-32: the four installation links point to the non-existent
v5.0 docs causing 404s; update each link to the latest published docs (change
/v5.0/ to /v4.4/ in the four URLs) or remove the hyperlinks and text referencing
v5.0 entirely if you prefer to avoid versioned links until v5.0 is published,
ensuring the Quick Start and Installation Docs links are valid after the change.
Summary by CodeRabbit