update README for 5.1 release#1137
Conversation
WalkthroughDocumentation references updated from version v5.0 to v5.1 across README files in both English and Chinese. Installation links, Quick Start references, and developer formatting documentation (pgindent/pg_bsd_indent tools and Cirrus FormatCheck workflow) have been refreshed to reflect the new version. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 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 |
There was a problem hiding this comment.
Actionable comments posted: 1
📜 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: pg_regression (ubuntu-latest)
- GitHub Check: contrib_regression
- GitHub Check: oracle_pg_regression (ubuntu-latest)
- GitHub Check: build (ubuntu-latest)
- GitHub Check: oracle_regression (ubuntu-latest)
- GitHub Check: meson_build (ubuntu-latest)
🔇 Additional comments (2)
README_CN.md (1)
30-30: Verify Chinese documentation URLs match English version structure.The Chinese README has been updated to reference v5.1 with
/cn/locale paths and Chinese anchors. Ensure these resolve correctly alongside the English documentation and that anchor naming conventions (#yum源安装,#docker安装,#rpm安装,#源码安装) match the actual documentation structure.The changes mirror the English version appropriately, with correct locale and language-specific anchor naming. Pending verification of the underlying documentation availability, the structural consistency between README.md and README_CN.md is sound.
Also applies to: 32-36
README.md (1)
34-37: Original review comment verified as accurate. The documented tool paths (src/tools/pgindent and src/tools/pg_bsd_indent) and CI workflow description align with standard PostgreSQL development practices. No corrections needed.
| We recommend following our [Quick Start](https://docs.ivorysql.org/en/ivorysql-doc/v5.1/v5.1/3.1#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/v5.0/v5.0/4.1#introduction). We provide four installation methods for IvorySQL, as outlined below: | ||
| - [Yum installation](https://docs.ivorysql.org/en/ivorysql-doc/v5.0/v5.0/4.1#Yum-installation) | ||
| - [Docker installation](https://docs.ivorysql.org/en/ivorysql-doc/v5.0/v5.0/4.1#Docker-installation) | ||
| - [Rpm installation](https://docs.ivorysql.org/en/ivorysql-doc/v5.0/v5.0/4.1#Rpm-installation) | ||
| - [Source code installation](https://docs.ivorysql.org/en/ivorysql-doc/v5.0/v5.0/4.1#Source-code-installation) | ||
| Furthermore, for more detailed installation instructions, please refer to the [Installation Docs](https://docs.ivorysql.org/en/ivorysql-doc/v5.1/v5.1/4.1#introduction). We provide four installation methods for IvorySQL, as outlined below: | ||
| - [Yum installation](https://docs.ivorysql.org/en/ivorysql-doc/v5.1/v5.1/4.1#Yum-installation) | ||
| - [Docker installation](https://docs.ivorysql.org/en/ivorysql-doc/v5.1/v5.1/4.1#Docker-installation) | ||
| - [Rpm installation](https://docs.ivorysql.org/en/ivorysql-doc/v5.1/v5.1/4.1#Rpm-installation) | ||
| - [Source code installation](https://docs.ivorysql.org/en/ivorysql-doc/v5.1/v5.1/4.1#Source-code-installation) |
There was a problem hiding this comment.
Update documentation links to v5.0 — v5.1 does not exist.
IvorySQL 5.0 was released recently as their latest version, not v5.1. All links in lines 26-32 point to non-existent v5.1 documentation. Update them to reference v5.0 instead (e.g., https://docs.ivorysql.org/en/ivorysql-doc/v5.0/v5.0/3.1#quick-installation).
🤖 Prompt for AI Agents
In README.md around lines 26 to 32, all documentation URLs point to a
non-existent v5.1 path; update each link to use v5.0 instead (for example change
https://docs.ivorysql.org/en/ivorysql-doc/v5.1/v5.1/3.1#quick-installation to
https://docs.ivorysql.org/en/ivorysql-doc/v5.0/v5.0/3.1#quick-installation) and
similarly replace v5.1 with v5.0 in the Installation Docs and the four specific
installation method links so they point to the correct v5.0 documentation pages.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.