Skip to content

Conversation

@zds-s
Copy link
Member

@zds-s zds-s commented Aug 17, 2025

Summary by CodeRabbit

  • 新功能
    • 侧边栏新增“联系我们/Contact Us/お問い合わせ/聯繫我們/聯絡我們”入口(多语言)。
    • 多语言新增“联系我们”文档(中文、英文、日文、繁体等),列出群组、维护者、社媒、求助与反馈渠道及响应时间。
  • 文档
    • 多处侧栏文本细化与标签调整以提升可读性。
  • 样式
    • 调整表格表头背景样式显示。
  • Chores
    • 精简站点构建与 CSS 配置,移除站点顶部公告集成。

@coderabbitai
Copy link

coderabbitai bot commented Aug 17, 2025

Walkthrough

移除 .vitepress/config.mts 中的 AnnouncementPlugin 及自定义的 build/css/define 配置,保留并格式化 llmstxt 插件;在多语言侧边栏(zh、en、ja、zh-hk、zh-tw)新增“联系我们”项并做若干文案调整;微调表格样式;新增多语言的“联系我们”文档页面(zh, en, ja, zh-hk, zh-tw)。

Changes

Cohort / File(s) Summary
VitePress 配置
.vitepress/config.mts
删除 AnnouncementPlugin 调用;移除显式 buildcssdefine 配置;保留 llmstxt 插件并调整格式。
侧边栏 — 多语言
.vitepress/src/zh/sidebars.ts, .../en/sidebars.ts, .../ja/sidebars.ts, .../zh-hk/sidebars.ts, .../zh-tw/sidebars.ts
在 /guide/ 介绍部分插入“🗣️ 联系我们”条目(链接 /guide/introduce/contact);并对若干语言条目文本做小幅重命名/标点调整(仅文案变更)。
样式微调
.vitepress/theme/styles/enhanced-tables.css
删除表头单元格的 background: transparent !important; 覆盖规则(仅表现样式变更)。
新增文档 — 联系我们(多语言)
docs/zh/guide/introduce/contact.md, docs/en/guide/introduce/contact.md, docs/ja/guide/introduce/contact.md, docs/zh-hk/guide/introduce/contact.md, docs/zh-tw/guide/introduce/contact.md
新增若干语言版本的“联系我们”页面,包含社群渠道、负责人/维护者联系信息、所有贡献者图片、官方账号、求助方式、反馈途径与响应时效等内容。

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20–30 minutes

Possibly related PRs

Poem

我是小兔来报到 🐇,
配置轻了尾巴摇;
侧栏添路朋友到,
文档门前灯火好;
若有问题来打招呼,群里等我点点头。

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch patch-1

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@vercel
Copy link

vercel bot commented Aug 17, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
doc-v3 Ready Ready Preview Comment Aug 17, 2025 9:46am

@netlify
Copy link

netlify bot commented Aug 17, 2025

Deploy Preview for super-cobbler-53ff65 failed. Why did it fail? →

Name Link
🔨 Latest commit a72ecd1
🔍 Latest deploy log https://app.netlify.com/projects/super-cobbler-53ff65/deploys/68a1a432bf03e700086943d9

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: 0

🧹 Nitpick comments (5)
.vitepress/theme/styles/enhanced-tables.css (1)

113-125: 请确认是否仍需覆盖表头单元格背景(th 的 background 声明)

当前 .VPDoc table thead th 里仍存在 background: transparent !important;。如果你的目标是让 thead 的渐变背景可见,这一行是有必要的;如果你的目标是恢复(或使用)单元格自身的默认背景,则需要删除这一行,否则始终是透明以透出 thead 背景。

如需去除 th 背景的透明覆盖,建议删除该行:

 .VPDoc table thead th {
   color: var(--table-header-text) !important;
   font-weight: var(--table-header-font-weight) !important;
   font-size: var(--table-header-font-size);
   text-align: left;
   padding: var(--table-cell-padding) !important;
   letter-spacing: 0.025em !important;
   text-transform: none !important;
   position: relative;
   white-space: nowrap;
   border-bottom: 2px solid rgba(255, 255, 255, 0.2);
-  background: transparent !important;
 }
docs/zh/guide/introduce/contact.md (3)

30-30: 为图片添加 alt 文本,修复 markdownlint(MD045) 并提升可访问性

contrib.rocks 图片添加可读的替代文本,方便读屏器使用,也能满足 lint 规则。

-<img src="https://contrib.rocks/image?repo=mineadmin/mineadmin" />
+<img src="https://contrib.rocks/image?repo=mineadmin/mineadmin" alt="MineAdmin 项目贡献者列表" />

23-23: 将邮箱转换为 mailto 链接,修复 markdownlint(MD034: Bare URL)

把裸露的邮箱文本改成 mailto 链接,既避免被 linter 标记,也更便于用户点击。

-- **邮箱**: [email protected]
+- **邮箱**: <a href="mailto:[email protected]">[email protected]</a>

-- **邮箱**: [email protected]
+- **邮箱**: <a href="mailto:[email protected]">[email protected]</a>

-- **安全漏洞**: [email protected](24小时内响应)
+- **安全漏洞**: <a href="mailto:[email protected]">[email protected]</a>(24小时内响应)

Also applies to: 26-26, 74-74


1-1: 建议补充 frontmatter(SEO/展示更友好)

建议在文档顶部加上 frontmatter,便于搜索引擎与主题展示(标题、描述、侧边栏高亮等)。

+---
+title: 联系我们
+description: MineAdmin 官方联系方式、交流群组、社交媒体与获取帮助的渠道
+---
+
 # 🗣️ 联系我们
.vitepress/config.mts (1)

60-62: 确认 llmstxt 的 ignoreFiles 匹配路径是否正确(多语言 srcDir 下)

当前 srcDirdocs/${currentLanguage},而 ignore 列表写的是 'changelog.md''index.md'。如果你的 changelog 实际位于 docs/zh/guide/changelog.md,则 'changelog.md' 可能不会被忽略。建议改为与实际相对路径一致的值(相对于各语言的 srcDir),例如:'guide/changelog.md'

-    llmstxt({
-      ignoreFiles:['changelog.md','index.md']
-    }),
+    llmstxt({
+      // 相对于 srcDir(docs/${currentLanguage})
+      ignoreFiles: ['guide/changelog.md', 'index.md']
+    }),

如不确定插件对路径的解析规则,可以先在本地构建一次,确认被忽略的文件是否正确生效。

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 6a28a6d and a8f4f22.

📒 Files selected for processing (4)
  • .vitepress/config.mts (1 hunks)
  • .vitepress/src/zh/sidebars.ts (1 hunks)
  • .vitepress/theme/styles/enhanced-tables.css (1 hunks)
  • docs/zh/guide/introduce/contact.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/zh/guide/introduce/contact.md

23-23: Bare URL used

(MD034, no-bare-urls)


26-26: Bare URL used

(MD034, no-bare-urls)


30-30: Images should have alternate text (alt text)

(MD045, no-alt-text)


74-74: Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (1)
.vitepress/src/zh/sidebars.ts (1)

25-28: 新增“联系我们”侧边栏项:LGTM

链接路径与中文文档位置一致(/guide/introduce/contact)。放置在“鸣谢”之后也符合导航语义。

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: 4

🧹 Nitpick comments (15)
docs/zh-tw/guide/introduce/contact.md (1)

22-27: 用語細節(可選):「郵箱」在繁體臺灣語境更常用「信箱」或「電子郵件」

不影響功能,僅語感優化,按需採納。

-**郵箱**: [[email protected]](mailto:[email protected])
+**信箱**: [[email protected]](mailto:[email protected])

-**郵箱**: [[email protected]](mailto:[email protected])
+**信箱**: [[email protected]](mailto:[email protected])
docs/ja/guide/introduce/contact.md (6)

22-27: 用 mailto 链接替换裸露邮箱,消除 markdownlint MD034 告警

当前两处邮箱为裸露文本,建议改为 mailto 链接,亦便于一键邮件发送。

建议改动:

- - **メール**: [email protected]
+ - **メール**: [[email protected]](mailto:[email protected])

- - **メール**: [email protected]
+ - **メール**: [[email protected]](mailto:[email protected])

30-30: 为图片添加替代文本(alt),消除 MD045 告警,提升无障碍

当前 img 标签缺少 alt 属性。请补充简洁、准确的日文描述。

建议改动:

-<img src="https://contrib.rocks/image?repo=mineadmin/mineadmin" />
+<img alt="mineadmin の全ての貢献者" src="https://contrib.rocks/image?repo=mineadmin/mineadmin" />

37-37: 避免以裸露 URL 作为链接文案,改用描述性文本

以 URL 充当链接文案会触发 MD034,且可读性较差。建议使用站点名作为锚文本。

建议改动:

-- **公式サイト**: [https://www.mineadmin.com](https://www.mineadmin.com)
+- **公式サイト**: [mineadmin.com](https://www.mineadmin.com)

73-74: 紧急联系方式同样改为 mailto 链接,统一风格并消除 MD034

与上文邮箱一致,这里也应使用 mailto。

建议改动:

-- **セキュリティ脆弱性**: [email protected](24時間以内に対応)
+- **セキュリティ脆弱性**: [[email protected]](mailto:[email protected])(24時間以内に対応)

18-21: 标题层级与内容结构不匹配:プロジェクトリーダー 下没有条目

“プロジェクトリーダー”为空,而“メンテナー”有内容。建议删除空标题,或补充对应负责人信息。若删除空标题,可将“メンテナー”提升为三级标题。

建议改动(将“メンテナー”提升为 H3,并移除空的“プロジェクトリーダー”与多余的 H4):

-### プロジェクトリーダー
-
-#### メンテナー
+### メンテナー

13-15: 公开个人即时通讯账号需确认授权与长期有效性

文档中公开了 WeChat 管理员账号(onloker_life、anmyt-m)。为避免个人隐私、骚扰与账号变更带来的维护成本,建议确认相关人员授权,或改为群二维码/企业微信/工单系统等更稳定的渠道。

如需,我可以协助提供一版“通过二维码入群 + 邮件/工单回退通道”的文本与版式。

docs/en/guide/introduce/contact.md (6)

22-27: Replace bare email with mailto links to satisfy markdownlint (MD034) and improve UX

Two email addresses are bare. Converting to mailto improves accessibility and linting.

Proposed diff:

- - **Email**: [email protected]
+ - **Email**: [[email protected]](mailto:[email protected])

- - **Email**: [email protected]
+ - **Email**: [[email protected]](mailto:[email protected])

30-30: Add alt text for image to resolve MD045 and improve accessibility

-<img src="https://contrib.rocks/image?repo=mineadmin/mineadmin" />
+<img alt="All contributors to mineadmin" src="https://contrib.rocks/image?repo=mineadmin/mineadmin" />

37-37: Use descriptive link text instead of a bare URL as the anchor text

Improves readability and avoids MD034-style complaints in some setups.

-- **Official Website**: [https://www.mineadmin.com](https://www.mineadmin.com)
+- **Official Website**: [mineadmin.com](https://www.mineadmin.com)

18-21: Empty “Project Leaders” section: fix heading hierarchy or add content

Currently “Project Leaders” has no entries while “Core Maintainers” does. Either add leaders or remove the empty heading and promote “Core Maintainers”.

-### Project Leaders
-
-#### Core Maintainers
+### Core Maintainers

68-70: 微调英文措辞以更自然、明确

  • “latest within 12 hours” 建议改为 “no later than 12 hours”
  • 三处响应时间句式统一为 “Response within …”/“No later than …”
-- **QQ Group**: Real-time response, latest within 12 hours
-**Discord**: Response within 24 hours
-**Email**: Response within 1-2 business days
+- **QQ Group**: Real-time; no later than 12 hours
+- **Discord**: Response within 24 hours
+- **Email**: Response within 1–2 business days

73-74: Urgent issues email: convert to mailto for consistency

-- **Security Vulnerabilities**: [email protected] (response within 24 hours)
+- **Security Vulnerabilities**: [[email protected]](mailto:[email protected]) (response within 24 hours)
.vitepress/src/en/sidebars.ts (2)

213-215: “Mobile Adaptation” 文案建议微调为更常见术语

在英文技术文档中更常用 “Mobile Responsiveness” 或 “Mobile Responsive”。

- text: '📱 Mobile Adaptation',
+ text: '📱 Mobile Responsiveness',

514-520: 统一 “Application Publishing/App Publishing” 文案,避免同页不一致

同一组内标题是 “Application Publishing”,子项是 “App Publishing”。建议统一为同一用词(任选其一),保证导航一致性。

两种统一方案(二选一):

  • 统一为 Application Publishing
- text:"🚀 Application Publishing",
+ text:"🚀 Application Publishing",
   ...
- text: "📦 App Publishing",
+ text: "📦 Application Publishing",
  • 统一为 App Publishing
- text:"🚀 Application Publishing",
+ text:"🚀 App Publishing",
   ...
- text: "📦 App Publishing",
+ text: "📦 App Publishing",
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between a8f4f22 and a72ecd1.

📒 Files selected for processing (8)
  • .vitepress/src/en/sidebars.ts (9 hunks)
  • .vitepress/src/ja/sidebars.ts (7 hunks)
  • .vitepress/src/zh-hk/sidebars.ts (1 hunks)
  • .vitepress/src/zh-tw/sidebars.ts (1 hunks)
  • docs/en/guide/introduce/contact.md (1 hunks)
  • docs/ja/guide/introduce/contact.md (1 hunks)
  • docs/zh-hk/guide/introduce/contact.md (1 hunks)
  • docs/zh-tw/guide/introduce/contact.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/zh-hk/guide/introduce/contact.md

23-23: Bare URL used

(MD034, no-bare-urls)


26-26: Bare URL used

(MD034, no-bare-urls)


30-30: Images should have alternate text (alt text)

(MD045, no-alt-text)


74-74: Bare URL used

(MD034, no-bare-urls)

docs/en/guide/introduce/contact.md

23-23: Bare URL used

(MD034, no-bare-urls)


26-26: Bare URL used

(MD034, no-bare-urls)


30-30: Images should have alternate text (alt text)

(MD045, no-alt-text)


74-74: Bare URL used

(MD034, no-bare-urls)

docs/ja/guide/introduce/contact.md

23-23: Bare URL used

(MD034, no-bare-urls)


26-26: Bare URL used

(MD034, no-bare-urls)


30-30: Images should have alternate text (alt text)

(MD045, no-alt-text)


74-74: Bare URL used

(MD034, no-bare-urls)

🪛 LanguageTool
docs/en/guide/introduce/contact.md

[grammar] ~1-~1: There might be a mistake here.
Context: # 🗣️ Contact Us ## 💬 Community Groups ### QQ Group - **Off...

(QB_NEW_EN)


[grammar] ~3-~3: There might be a mistake here.
Context: ...# 🗣️ Contact Us ## 💬 Community Groups ### QQ Group - Official QQ Group: 1501054...

(QB_NEW_EN)


[grammar] ~5-~5: There might be a mistake here.
Context: ...Us ## 💬 Community Groups ### QQ Group - Official QQ Group: 150105478 ### Disc...

(QB_NEW_EN)


[grammar] ~8-~8: There might be a mistake here.
Context: ...icial QQ Group**: 150105478 ### Discord - Official Discord: [Join our Discord se...

(QB_NEW_EN)


[grammar] ~12-~12: There might be a mistake here.
Context: ...cal exchanges, and Q&A ### WeChat Group - WeChat Group: Please add the admin's W...

(QB_NEW_EN)


[grammar] ~16-~16: There might be a mistake here.
Context: ...fe anmyt-m` ## 📧 Contact Information ### Project Leaders #### Core Maintainers -...

(QB_NEW_EN)


[grammar] ~22-~22: There might be a mistake here.
Context: ...ore Maintainers - GitHub: @kanyxmo - Email: [email protected] - GitHub:...

(QB_NEW_EN)


[grammar] ~25-~25: There might be a mistake here.
Context: ... [email protected] - GitHub: @zds-s - Email: [email protected] ### All Cont...

(QB_NEW_EN)


[grammar] ~32-~32: There might be a mistake here.
Context: ...eadmin/mineadmin" /> ## 🌐 Social Media ### Official Accounts - GitHub: [mineadmi...

(QB_NEW_EN)


[grammar] ~34-~34: There might be a mistake here.
Context: ...# 🌐 Social Media ### Official Accounts - GitHub: [mineadmin/mineadmin](https://...

(QB_NEW_EN)


[grammar] ~35-~35: There might be a mistake here.
Context: ...ounts - GitHub: mineadmin/mineadmin - Gitee: [mineadmin/mineadmin](https://g...

(QB_NEW_EN)


[grammar] ~36-~36: There might be a mistake here.
Context: ...admin) - Gitee: mineadmin/mineadmin - Official Website: [https://www.mineadm...

(QB_NEW_EN)


[grammar] ~39-~39: There might be a mistake here.
Context: ...ww.mineadmin.com) ## 📋 How to Get Help ### 1. FAQs First, check our [FAQ Page](/faq/...

(QB_NEW_EN)


[grammar] ~41-~41: There might be a mistake here.
Context: ...com) ## 📋 How to Get Help ### 1. FAQs First, check our FAQ Page, wher...

(QB_NEW_EN)


[grammar] ~44-~44: There might be a mistake here.
Context: ...ns are answered. ### 2. Document Search Use the search function in the top-right...

(QB_NEW_EN)


[grammar] ~47-~47: There might be a mistake here.
Context: ...evant information. ### 3. GitHub Issues For bug reports and feature requests, pl...

(QB_NEW_EN)


[grammar] ~50-~50: There might be a mistake here.
Context: ...admin/issues). ### 4. Discussion Groups Join our discussion groups to exchange e...

(QB_NEW_EN)


[grammar] ~51-~51: There might be a mistake here.
Context: ...hange experiences with other developers: - QQ Group: 150105478 - Discord: [Join Her...

(QB_NEW_EN)


[grammar] ~52-~52: There might be a mistake here.
Context: ... other developers: - QQ Group: 150105478 - Discord: [Join Here](https://discord.gg/...

(QB_NEW_EN)


[grammar] ~55-~55: There might be a mistake here.
Context: .../9jEyY6SC) ## 📝 Feedback & Suggestions We highly value user feedback and suggest...

(QB_NEW_EN)


[grammar] ~59-~59: There might be a mistake here.
Context: ...ls: ### Product Improvement Suggestions - Feature Requests: [GitHub Feature Requ...

(QB_NEW_EN)


[grammar] ~62-~62: There might be a mistake here.
Context: ...ues/new) ### Documentation Improvements - Documentation Issues: [Documentation R...

(QB_NEW_EN)


[grammar] ~67-~67: There might be a mistake here.
Context: ...# ⏰ Response Time ### General Inquiries - QQ Group: Real-time response, latest w...

(QB_NEW_EN)


[grammar] ~68-~68: There might be a mistake here.
Context: ...al-time response, latest within 12 hours - Discord: Response within 24 hours - **...

(QB_NEW_EN)


[grammar] ~69-~69: There might be a mistake here.
Context: ... - Discord: Response within 24 hours - Email: Response within 1-2 business da...

(QB_NEW_EN)


[grammar] ~72-~72: There might be a mistake here.
Context: ...hin 1-2 business days ### Urgent Issues - Security Vulnerabilities: 2771717608@q...

(QB_NEW_EN)

🔇 Additional comments (17)
.vitepress/src/zh-hk/sidebars.ts (1)

25-27: 确认无遗漏:所有语言文档与侧边栏已同步配置

  • 已验证 docs/{en,ja,zh,zh-hk,zh-tw}/guide/introduce/contact.md 均存在
  • 已验证所有 .vitepress/src/**/sidebars.ts 文件中均包含 /guide/introduce/contact 链接

无需进一步修改。

docs/zh-hk/guide/introduce/contact.md (1)

30-30: 補充圖片替代文字以通過 MD045 並提升無障礙

圖片缺少 alt 文本,違反 markdownlint MD045。補充簡潔的替代文字說明。

-<img src="https://contrib.rocks/image?repo=mineadmin/mineadmin" />
+<img src="https://contrib.rocks/image?repo=mineadmin/mineadmin" alt="MineAdmin 項目貢獻者一覽" />
⛔ Skipped due to learnings
Learnt from: People-Sea
PR: mineadmin/doc-v3#0
File: :0-0
Timestamp: 2025-08-11T15:28:39.641Z
Learning: 用户 People-Sea 指示在 mineadmin/doc-v3 仓库的 PR 审查中暂时不需要检查 markdown (.md) 文件的内容。
.vitepress/src/zh-tw/sidebars.ts (1)

25-27: 确认:各语言“🗣️ 联络我们”导航项已同步齐备

  • 已在以下路径发现对应文档:
    • docs/en/guide/introduce/contact.md
    • docs/ja/guide/introduce/contact.md
    • docs/zh/guide/introduce/contact.md
    • docs/zh-hk/guide/introduce/contact.md
    • docs/zh-tw/guide/introduce/contact.md
  • 在 .vitepress/src 下各语言的 sidebars.ts 文件中,均正确引用了 /guide/introduce/contact

批准此变更,无需额外操作。

docs/zh-tw/guide/introduce/contact.md (1)

41-46: 无法在 docsdocs/zh-tw 目录下找到对应的 faq.mdfaq/index.md,请手动在本地预览中确认 /faq/ 链接是否正确映射到繁体(台湾)版本的 FAQ 页面;如映射失败,建议改用带有本地化前缀的路径(例如 /zh-tw/faq/)或相对路由以确保跳转正确。

.vitepress/src/ja/sidebars.ts (2)

10-10: 日文文案微調整整體更自然、統一—變更均合理

  • 問號由全角改半角(なぜ私たちを選ぶのか?),常見且可讀性更佳
  • 「貢献ガイド」「高度なトピック」「テーブルフィルター」「エラー処理」「API リファレンス」等用語更貼近日常表述
    無語法問題,可保持。

Also applies to: 58-58, 138-138, 240-240, 368-368, 480-480


26-27: 确认「🗣️ お問い合わせ」导航项与日文文档对齐

  • 已验证 docs/ja/guide/introduce/contact.md 存在
  • 链接 /guide/introduce/contact 放置在 Introduction 下,位置合理
docs/ja/guide/introduce/contact.md (1)

41-46: 已验证 /faq/ 页面在所有语言环境中均存在
对应文件列表:

  • docs/en/faq/index.md
  • docs/ja/faq/index.md
  • docs/zh/faq/index.md
  • docs/zh-hk/faq/index.md
  • docs/zh-tw/faq/index.md
docs/en/guide/introduce/contact.md (1)

41-43: 已确认 /faq/ 路由存在
已验证 docs/en/faq/index.md 文件存在,保证 /faq/ 路由不会导致 404。

.vitepress/src/en/sidebars.ts (9)

22-24: “Acknowledgments” 拼写统一很好,保持美式英文风格

文本标签更一致,易于国际读者理解。


78-80: 文案重命名为 “Routes & Menus” 👍

仅文案改动,路由不变,风险低。


252-254: “Pagination Table” 文案更明确,赞

更贴近内容,易检索。


260-262: “Multi-select Table” 文案清晰,赞

更准确表达选择能力。


291-293: “Dynamic Management” 文案更贴近示例内容

与链接 /front/component/ma-search/examples/dynamic-items 保持一致性更好。


367-367: 后端路由文案改为 “Routes & API Docs” 更直观

仅标签更新,链接保持 /backend/base/router,无需额外改动。


380-386: 安全章节文案更明确(Authentication/Authorization)

符合主流术语习惯,便于用户理解。


453-455: 插件目录结构命名更完整

从 “Plugin Structure” 到 “Plugin Directory Structure” 更精确。


25-28: ✅ 多语言文档已就位
已在以下语言版本中确认存在 docs/<lang>/guide/introduce/contact.md

  • en (标题:🗣️ Contact Us)
  • ja
  • zh

侧边栏新菜单项路径正确,可安全合并。

#### 主要維護者

- **GitHub**: [@kanyxmo](https://github.com/kanyxmo)
- **郵箱**: [email protected]
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

修正 markdownlint MD034(裸露地址):將郵箱轉為 mailto 連結

當前為純文本郵箱,會被 linter 視為裸露地址。建議使用 mailto 以提升可點擊性與可及性。

-**郵箱**: [email protected]
+**郵箱**: [[email protected]](mailto:[email protected])

-**郵箱**: [email protected]
+**郵箱**: [[email protected]](mailto:[email protected])

-**安全漏洞**: [email protected](24小時內響應)
+**安全漏洞**: [[email protected]](mailto:[email protected])(24小時內響應)

Also applies to: 26-26, 74-74

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

23-23: Bare URL used

(MD034, no-bare-urls)

🤖 Prompt for AI Agents
In docs/zh-hk/guide/introduce/contact.md around lines 23 (also apply to lines 26
and 74), the plain-text email is flagged as a naked address by markdownlint
MD034; replace the raw email with a mailto link (e.g.
[[email protected]](mailto:[email protected])) for each occurrence so the address
is clickable and compliant with the linter.

Comment on lines +41 to +46
### 1. 常見問題
首先查看我們的 [FAQ 頁面](/faq/),大部分常見問題都能在這裏找到答案。

### 2. 文檔搜索
使用文檔右上角的搜索功能,快速找到相關信息。

Copy link

Choose a reason for hiding this comment

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

💡 Verification agent

🧩 Analysis chain

確認 /faq/ 鏈接在多語言環境下是否自動帶上本地化前綴

在 VitePress 多語言站點中,形如「/faq/」的根相對路由通常會自動解析,但不同配置下可能需要顯式本地化前綴(如 /zh-hk/faq/)。請在本地預覽確認該鏈接是否正確跳轉至繁中(香港)內容。

若需靜態核查文檔是否存在,可先檢索 FAQ 文檔文件:


🏁 Script executed:

#!/bin/bash
echo "Searching for FAQ files…"
fd -i -a -t f "faq.md" docs || true
fd -i -a -t f "faq/index.md" docs || true
# 如果沒有對應語言 FAQ 文件,考慮調整鏈接或補齊文檔

Length of output: 120


请补充或修正 zh-hk 本地化 FAQ 页面及链接

  • docs/zh-hk/ 目录下未发现 faq.mdfaq/index.md,建议新增对应文件以提供繁体(香港)版 FAQ。
  • 如果 VitePress 已配置自动为根相对链接添加本地化前缀,请本地预览确认 /faq/ 是否跳转至 /zh-hk/faq/;否则应将链接改为绝对路径 /zh-hk/faq/

修改示例(docs/zh-hk/guide/introduce/contact.md 第 41–46 行):

- 首先查看我們的 [FAQ 頁面](/faq/),大部分常見問題都能在這裏找到答案。
+ 首先查看我們的 [FAQ 頁面](/zh-hk/faq/),大部分常見問題都能在這裏找到答案。
📝 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
### 1. 常見問題
首先查看我們的 [FAQ 頁面](/faq/),大部分常見問題都能在這裏找到答案。
### 2. 文檔搜索
使用文檔右上角的搜索功能,快速找到相關信息。
### 1. 常見問題
首先查看我們的 [FAQ 頁面](/zh-hk/faq/),大部分常見問題都能在這裏找到答案。
### 2. 文檔搜索
使用文檔右上角的搜索功能,快速找到相關信息。
🤖 Prompt for AI Agents
In docs/zh-hk/guide/introduce/contact.md around lines 41 to 46, the link points
to /faq/ but there is no zh-hk FAQ file and it may not route to the localized
path; add a zh-hk FAQ page (docs/zh-hk/faq.md or docs/zh-hk/faq/index.md) with
the localized FAQ content, or if you prefer a directory variant add index.md
under docs/zh-hk/faq/, then update the link in this file to the localized
absolute path (/zh-hk/faq/) unless your VitePress config already rewrites root
links—verify by running a local dev preview to ensure /faq/ correctly redirects
to /zh-hk/faq/ and adjust the link accordingly.

#### 主要維護者

- **GitHub**: [@kanyxmo](https://github.com/kanyxmo)
- **郵箱**: [email protected]
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

修正 markdownlint MD034(裸露地址):郵箱改為 mailto 連結

以可點擊的 mailto 形式呈現,同時消除裸露地址告警。

-**郵箱**: [email protected]
+**郵箱**: [[email protected]](mailto:[email protected])

-**郵箱**: [email protected]
+**郵箱**: [[email protected]](mailto:[email protected])

-**安全漏洞**: [email protected](24小時內響應)
+**安全漏洞**: [[email protected]](mailto:[email protected])(24小時內響應)

Also applies to: 26-26, 74-74

🤖 Prompt for AI Agents
In docs/zh-tw/guide/introduce/contact.md around lines 23 (also applies to lines
26 and 74), the raw email address triggers markdownlint MD034; replace each bare
email with a clickable mailto link (e.g., change plain "[email protected]" to a
markdown link using mailto) so the address is not exposed as bare text and the
link is clickable, preserving existing label text formatting.


### 所有貢獻者

<img src="https://contrib.rocks/image?repo=mineadmin/mineadmin" />
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

為貢獻者圖片補充 alt 文本以通過 MD045

加上替代文字,改善無障礙與 SEO。

-<img src="https://contrib.rocks/image?repo=mineadmin/mineadmin" />
+<img src="https://contrib.rocks/image?repo=mineadmin/mineadmin" alt="MineAdmin 專案貢獻者一覽" />
📝 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
<img src="https://contrib.rocks/image?repo=mineadmin/mineadmin" />
<img src="https://contrib.rocks/image?repo=mineadmin/mineadmin" alt="MineAdmin 專案貢獻者一覽" />
🤖 Prompt for AI Agents
In docs/zh-tw/guide/introduce/contact.md around line 30, the <img> tag lacks an
alt attribute which fails MD045; add a concise, descriptive alt attribute (e.g.,
alt="MineAdmin 貢獻者" or alt="貢獻者圖示") to the tag to improve accessibility and SEO
so the image element becomes <img
src="https://contrib.rocks/image?repo=mineadmin/mineadmin" alt="...">.

@zds-s zds-s merged commit 393a7f2 into main Aug 17, 2025
4 of 8 checks passed
@zds-s zds-s deleted the patch-1 branch August 17, 2025 12:45
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.

1 participant