Skip to content

docs: fix cluster deployment table line breaks#163

Merged
Calcium-Ion merged 1 commit into
QuantumNous:mainfrom
Sourgrapes42:docs/fix-cluster-deployment-table-line-breaks
Jul 1, 2026
Merged

docs: fix cluster deployment table line breaks#163
Calcium-Ion merged 1 commit into
QuantumNous:mainfrom
Sourgrapes42:docs/fix-cluster-deployment-table-line-breaks

Conversation

@Sourgrapes42

@Sourgrapes42 Sourgrapes42 commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

This PR fixes a table rendering issue in the Chinese documentation only.

The problem exists in [cluster-deployment.mdx], where line break tags inside table cells were written in a way that caused them to render as literal text. This change restores the intended table layout and readability.

Before

image

After

image

Summary by CodeRabbit

  • Documentation
    • Corrected HTML markup in the cluster deployment documentation to ensure proper rendering of deployment architecture descriptions and layout in the database configuration section.

Copilot AI review requested due to automatic review settings June 9, 2026 06:46
@vercel

vercel Bot commented Jun 9, 2026

Copy link
Copy Markdown

@Sourgrapes42 is attempting to deploy a commit to the quantumnous Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Jun 9, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2489c87c-31cd-4e09-bb2a-a3bf00439f6a

📥 Commits

Reviewing files that changed from the base of the PR and between c031fad and 80504aa.

📒 Files selected for processing (1)
  • content/docs/zh/installation/deployment-methods/cluster-deployment.mdx

Walkthrough

This PR fixes HTML markup rendering in the cluster deployment documentation by removing errant backticks around <br /> line-break tags within a table's architecture descriptions. The change is localized to two rows in the "准备共享数据库和 Redis" section.

Changes

Cluster Deployment Documentation Markup

Layer / File(s) Summary
Markdown table line-break fix
content/docs/zh/installation/deployment-methods/cluster-deployment.mdx
Removes incorrect backticks around <br /> tags in the "主从复制架构" and "数据库集群架构" table rows to ensure proper line-break rendering.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A rabbit hops through docs with care,
Backticks around breaks here and there—
Swish! They're gone, the table's clean,
The prettiest lines you've ever seen! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title accurately summarizes the main change: fixing line break rendering in a cluster deployment documentation table by correcting HTML markup.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates the Chinese cluster deployment documentation to simplify table formatting by removing unnecessary inline code wrappers around HTML line breaks.

Changes:

  • Removed backticks around <br /> in the architecture comparison table to render line breaks consistently.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +47 to +48
| **主从复制架构** | 1个主库<br />N个从库 | 主库处理写入<br />从库处理读取<br />主从数据自动同步 | 配置主库地址作为 `SQL_DSN` |
| **数据库集群架构** | 多个对等节点<br />代理层(ProxySQL/MySQL Router) | 所有节点都可读写<br />通过代理层实现负载均衡<br />自动故障转移 | 配置代理层地址作为 `SQL_DSN` |
@Calcium-Ion Calcium-Ion merged commit 4898b58 into QuantumNous:main Jul 1, 2026
1 of 2 checks passed
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.

3 participants