Skip to content

i18n: fix invalid SVG markup that caused doc build failure #22011

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 5, 2025
Merged

i18n: fix invalid SVG markup that caused doc build failure #22011

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion tidb-cloud/release-notes-2023.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@
- 优化整体导航体验，具体变更如下：

- 将右上角 <MDSvgIcon name="icon-top-organization" /> **Organization** 和 <MDSvgIcon name="icon-top-account-settings" /> **Account** 合并至左侧导航栏。
- 将左侧导航栏 <svg ...></svg> **Admin** 合并至 <MDSvgIcon name="icon-left-projects" /> **Project**，并移除左上角 ☰ 悬浮菜单。现在可通过 <MDSvgIcon name="icon-left-projects" /> 切换项目及修改项目设置。
- 将左侧导航栏 <svg width="20" height="20" viewBox="0 0 24 24" fill="none" stroke-width="1.5" xmlns="http://www.w3.org/2000/svg"><path d="M12 14.5H7.5C6.10444 14.5 5.40665 14.5 4.83886 14.6722C3.56045 15.06 2.56004 16.0605 2.17224 17.3389C2 17.9067 2 18.6044 2 20M14.5 6.5C14.5 8.98528 12.4853 11 10 11C7.51472 11 5.5 8.98528 5.5 6.5C5.5 4.01472 7.51472 2 10 2C12.4853 2 14.5 4.01472 14.5 6.5ZM22 16.516C22 18.7478 19.6576 20.3711 18.8054 20.8878C18.7085 20.9465 18.6601 20.9759 18.5917 20.9911C18.5387 21.003 18.4613 21.003 18.4083 20.9911C18.3399 20.9759 18.2915 20.9465 18.1946 20.8878C17.3424 20.3711 15 18.7478 15 16.516V14.3415C15 13.978 15 13.7962 15.0572 13.6399C15.1077 13.5019 15.1899 13.3788 15.2965 13.2811C15.4172 13.1706 15.5809 13.1068 15.9084 12.9791L18.2542 12C18.3452 11.9646 18.4374 11.8 18.4374 11.8H18.5626C18.5626 11.8 18.6548 11.9646 18.7458 12L21.0916 12.9791C21.4191 13.1068 21.5828 13.1706 21.7035 13.2811C21.8101 13.3788 21.8923 13.5019 21.9428 13.6399C22 13.7962 22 13.978 22 14.3415V16.516Z" stroke="currentColor" stroke-width="inherit" stroke-linecap="round" stroke-linejoin="round"></path></svg> **Admin** 合并至 <MDSvgIcon name="icon-left-projects" /> **Project**，并移除左上角 ☰ 悬浮菜单。现在可通过 <MDSvgIcon name="icon-left-projects" /> 切换项目及修改项目设置。

Check failure on line 390 in tidb-cloud/release-notes-2023.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[PingCAP.ZhPunctuation] Don't use Chinese punctuation (。) in English text.

Raw Output:
{"message": "[PingCAP.ZhPunctuation] Don't use Chinese punctuation (。) in English text.", "location": {"path": "tidb-cloud/release-notes-2023.md", "range": {"start": {"line": 390, "column": 1205}}}, "severity": "ERROR"}

Check failure on line 390 in tidb-cloud/release-notes-2023.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[PingCAP.ZhPunctuation] Don't use Chinese punctuation (，) in English text.

Raw Output:
{"message": "[PingCAP.ZhPunctuation] Don't use Chinese punctuation (，) in English text.", "location": {"path": "tidb-cloud/release-notes-2023.md", "range": {"start": {"line": 390, "column": 1191}}}, "severity": "ERROR"}
Copy link

@gemini-code-assist gemini-code-assist bot Nov 5, 2025

Choose a reason for hiding this comment

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

medium

While this change correctly fixes the invalid SVG markup, it introduces a large, inlined SVG into the document. This harms readability and is inconsistent with the rest of the file, which uses the <MDSvgIcon> component for icons (e.g., <MDSvgIcon name="icon-left-projects" />).12

For better maintainability and consistency, please use the <MDSvgIcon> component instead. I've suggested using icon-left-admin as the name, but please verify if this is the correct name in your icon library or add it if it's a new icon.

Suggested change
- 将左侧导航栏 <svg width="20" height="20" viewBox="0 0 24 24" fill="none" stroke-width="1.5" xmlns="http://www.w3.org/2000/svg"><path d="M12 14.5H7.5C6.10444 14.5 5.40665 14.5 4.83886 14.6722C3.56045 15.06 2.56004 16.0605 2.17224 17.3389C2 17.9067 2 18.6044 2 20M14.5 6.5C14.5 8.98528 12.4853 11 10 11C7.51472 11 5.5 8.98528 5.5 6.5C5.5 4.01472 7.51472 2 10 2C12.4853 2 14.5 4.01472 14.5 6.5ZM22 16.516C22 18.7478 19.6576 20.3711 18.8054 20.8878C18.7085 20.9465 18.6601 20.9759 18.5917 20.9911C18.5387 21.003 18.4613 21.003 18.4083 20.9911C18.3399 20.9759 18.2915 20.9465 18.1946 20.8878C17.3424 20.3711 15 18.7478 15 16.516V14.3415C15 13.978 15 13.7962 15.0572 13.6399C15.1077 13.5019 15.1899 13.3788 15.2965 13.2811C15.4172 13.1706 15.5809 13.1068 15.9084 12.9791L18.2542 12C18.3452 11.9646 18.4374 11.8 18.4374 11.8H18.5626C18.5626 11.8 18.6548 11.9646 18.7458 12L21.0916 12.9791C21.4191 13.1068 21.5828 13.1706 21.7035 13.2811C21.8101 13.3788 21.8923 13.5019 21.9428 13.6399C22 13.7962 22 13.978 22 14.3415V16.516Z" stroke="currentColor" stroke-width="inherit" stroke-linecap="round" stroke-linejoin="round"></path></svg> **Admin** 合并至 <MDSvgIcon name="icon-left-projects" /> **Project**，并移除左上角 ☰ 悬浮菜单。现在可通过 <MDSvgIcon name="icon-left-projects" /> 切换项目及修改项目设置。
- 将左侧导航栏 <MDSvgIcon name="icon-left-admin" /> **Admin** 合并至 <MDSvgIcon name="icon-left-projects" /> **Project**，并移除左上角 ☰ 悬浮菜单。现在可通过 <MDSvgIcon name="icon-left-projects" /> 切换项目及修改项目设置。

Style Guide References

Footnotes

  1. The documentation should be clear, simple, and readable. Inlining a large SVG blob reduces readability. ↩

  2. The documentation should use consistent patterns and terminology. This file uses the <MDSvgIcon> component for icons, and this change should follow that pattern for consistency. ↩

- 所有帮助与支持信息整合至右下角 **?** 菜单，包括文档、交互式教程、自学课程和支持入口。

- TiDB Cloud 控制台现支持暗黑模式，提供更舒适、护眼的体验。可在左侧导航栏底部切换明暗模式。
Expand Down
Loading