Skip to content

i18n(zh-CN): update Chinese UI strings#135

Merged
dreyfus92 merged 28 commits into
withstudiocms:mainfrom
jenxi:main
Jul 8, 2025
Merged

i18n(zh-CN): update Chinese UI strings#135
dreyfus92 merged 28 commits into
withstudiocms:mainfrom
jenxi:main

Conversation

@jenxi
Copy link
Copy Markdown
Contributor

@jenxi jenxi commented Jun 3, 2025

Description

  • Adds Chinese translation config and update Chinese UI strings
  • Adds Chinese docs pages

Summary by CodeRabbit

  • New Features
    • Added support for Simplified Chinese language throughout the application.
    • Introduced Chinese translations for UI labels, messages, sidebar navigation, and documentation.
    • Enabled Simplified Chinese as an available language option in the language selector.
    • Published new Chinese-language guides including quick start, environment variables, and tutorial indexes.

jenxi added 3 commits June 3, 2025 18:40
add Chinese translation config and update Chinese UI strings
Created files for Chinese pages
@jenxi jenxi requested a review from a team as a code owner June 3, 2025 12:19
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 3, 2025

Walkthrough

The changes enable Simplified Chinese (zh-CN/zh-cn) as a supported locale across the project. This includes uncommenting Chinese locale entries in configuration files, updating the available translations list, and adding new JSON files with Chinese translations for UI and sidebar navigation labels. Additionally, new Chinese documentation pages for guides and environment variables have been added.

Changes

Files/Paths Change Summary
astro.config.mts, lunaria.config.ts Uncommented and enabled Simplified Chinese locale entries in configuration objects/arrays.
src/starlight-sidebar/availTranslations.ts Added 'zh-cn' to the array of available translations.
src/content/i18n/zh-CN.json Added new file with 49 key-value pairs for UI and message translations in Simplified Chinese.
src/starlight-sidebar/zh-cn.json Added new file with sidebar navigation labels translated into Simplified Chinese.
src/content/docs/zh-cn/guides/index.mdx Added new Chinese documentation index page organizing StudioCMS guides.
src/content/docs/zh-cn/start-here/environment-variables.mdx Added new Chinese documentation on environment variables for StudioCMS.
src/content/docs/zh-cn/start-here/getting-started.mdx Added new comprehensive Chinese quick start guide for StudioCMS.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant LocaleConfig
    participant TranslationFiles

    User->>App: Selects Chinese locale
    App->>LocaleConfig: Loads 'zh-cn' locale configuration
    App->>TranslationFiles: Loads zh-CN.json and zh-cn.json
    App-->>User: Displays UI and sidebar in Simplified Chinese
Loading

Possibly related PRs

Suggested reviewers

  • Adammatthiesen

Poem

🐇
A hop and a skip, a locale anew,
Now Chinese words join our language crew!
Sidebars and buttons, all dressed up to see,
欢迎, dear friends, to our global spree!
With each translation, our world grows wide—
Let’s code together, side by side!
🌏✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fcfa013 and 7da7bb4.

📒 Files selected for processing (1)
  • src/content/docs/zh-cn/start-here/getting-started.mdx (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: ArmandPhilippot
PR: withstudiocms/docs#130
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-17.mdx:1-11
Timestamp: 2025-04-26T12:29:17.995Z
Learning: When reviewing translations in the withstudiocms/docs repository, compare with the corresponding English version as the source of truth, not with other files in the same target language. French translations should maintain structural parity with their English counterparts.
src/content/docs/zh-cn/start-here/getting-started.mdx (1)
Learnt from: ArmandPhilippot
PR: withstudiocms/docs#130
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-17.mdx:1-11
Timestamp: 2025-04-26T12:29:17.995Z
Learning: When reviewing translations in the withstudiocms/docs repository, compare with the corresponding English version as the source of truth, not with other files in the same target language. French translations should maintain structural parity with their English counterparts.
🪛 Gitleaks (8.26.0)
src/content/docs/zh-cn/start-here/getting-started.mdx

62-62: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

🔇 Additional comments (2)
src/content/docs/zh-cn/start-here/getting-started.mdx (2)

15-15: Link locale casing now matches directory – looks good.
The href uses /zh-cn/…, consistent with the folder name under src/content/docs/zh-cn.


341-347: Anchors Verified in environment-variables.mdx
The headings for @astrojs/db (“数据库连接参数”) and @studiocms-auth (“加密密钥”) produce the slugs astrojsdb-数据库连接参数 and studiocms-auth-加密密钥, which exactly match the link targets. No changes required.


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.
    • Explain this complex logic.
    • 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. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • 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 src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

Documentation and Community

  • 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.

Copy link
Copy Markdown
Contributor

@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: 13

🧹 Nitpick comments (49)
src/content/docs/zh-cn/package-catalog/studiocms-plugins/studiocms-markdoc.mdx (3)

13-15: Remove unused imports
The Steps, Tabs, and TabItem components are imported but never used in this document. Please remove them to avoid clutter and potential bundle size impact.


22-25: Consider using <Steps> for consistency
Since you’ve imported the Starlight Steps component, you could replace the plain numbered list with a <Steps> component to match other integration docs. This would improve visual consistency across the docs.


28-36: Ensure code block is properly fenced and highlights match

  • Verify there is a closing set of triple backticks (\```) after the example.
  • Check that the {2, 6} highlight range corresponds to the intended lines in the snippet.
src/content/docs/zh-cn/guides/index.mdx (1)

15-17: Clarify non-link bullet or convert to plain text
The second item under “升级指南” is a standalone sentence (“更多版本特定指南请查看侧边栏导航”) but is formatted as a list item. Consider moving it outside the list or indenting it as subtext to avoid confusion.

src/content/docs/zh-cn/package-catalog/studiocms-plugins/studiocms-mdx.mdx (3)

13-15: Remove unused imports
The Steps, Tabs, and TabItem components are imported but not used. Please remove them to keep the document lean.


22-25: Optional: Switch to <Steps> for step-by-step UI
To maintain a consistent look with other plugin docs, you could render the installation steps using the imported Steps component instead of a Markdown list.


28-36: Check code block termination and highlights

  • Ensure there’s a closing triple-backtick after the snippet.
  • Verify the {2, 6} highlighting matches the intended lines in the example.
src/content/docs/zh-cn/config-reference/image-service.mdx (2)

9-9: Remove unused ReadMore import
The ReadMore component is imported but never used in this document. Please delete the import to prevent dead code.


11-11: Minor grammar polish
The heading “StudioCMS 集成配置选项架构参考” could read more naturally as “StudioCMS 集成配置选项的架构参考”。 Consider adding “的” for smoother Chinese.

src/content/docs/zh-cn/utils/rendering.mdx (1)

21-23: Normalize indentation to spaces.
Line 21 uses a tab character for indentation, while the rest of the snippet uses spaces. For readability and consistency, replace tabs with two spaces throughout this code block.

src/content/docs/zh-cn/package-catalog/studiocms-plugins/studiocms-wysiwyg.mdx (1)

1-11: Check frontmatter for sidebar ordering.
The sidebar field only defines a badge; it might be beneficial to add an order property to control the position of this plugin in the package catalog sidebar, matching patterns in other plugin docs.

src/content/docs/zh-cn/package-catalog/community-plugins/web-vitals.mdx (1)

23-27: Remove or re-enable the commented <Steps> wrapper.
The <Steps> component is commented out around your tab content. Either remove these commented lines for clarity or re-enable <Steps> to maintain consistency with other plugin docs.

src/content/docs/zh-cn/guides/contributing/getting-started.mdx (2)

26-27: Remove placeholder comment.
The comment {/* 链接 */} appears to be leftover—consider removing it to clean up the MDX content.


10-14: Polish translation tone (optional).
Consider refining “感谢您投入时间贡献我们的项目!” to a more natural phrasing like “感谢您抽出时间为我们的项目做出贡献!”, which may read smoother in Chinese.

src/content/docs/zh-cn/guides/upgrade/version-guides/0-1-0-beta-16.mdx (1)

42-42: Add space before link in ReadMore component.
For better readability in Chinese, insert a space before the link reference:

-<ReadMore>详细了解 CLI 新功能请参阅[命令行工具文档][cli-docs]</ReadMore>
+<ReadMore>详细了解 CLI 新功能请参阅 [命令行工具文档][cli-docs]</ReadMore>
src/content/docs/zh-cn/index.mdx (3)

24-25: Remove unused import of Youtube.
The Youtube component is imported but never used. Either integrate it (e.g., use <Youtube id="…"/>) or remove the import:

-import Youtube from '~/components/Youtube.astro';

31-31: Unify quotation marks in JSX attributes.
Mixing single and double quotes can be confusing. For example:

-<Card title="StudioCMS 演示" icon='seti:video'>
+<Card title="StudioCMS 演示" icon="seti:video">
 ...
-<LinkButton 
-  href='https://chat.studiocms.dev' 
+<LinkButton 
+  href="https://chat.studiocms.dev" 

Also applies to: 77-84


52-52: Consistent Markdown reference label casing.
The link text uses [Turso] but the label is defined as [turso]. While CommonMark is case-insensitive, consistent casing improves readability. Consider:

-需要 libSQL 数据库?请了解 [Turso][turso]。
+[Turso]: https://tur.so/studiocms

→ change to uppercase [Turso]: … or lowercase both.

Also applies to: 91-93

src/content/docs/zh-cn/config-reference/included-integrations.mdx (2)

9-10: Remove unused ReadMore import.
Since ReadMore isn’t used in this document, you can safely delete:

-import ReadMore from '~/components/ReadMore.astro';

4-4: Refine front matter description for clarity.
Consider adjusting the description to use backticks for code identifiers and natural Chinese phrasing:

-description: "StudioCMSOptions IncludedIntegrations 参考文档"
+description: "`StudioCMSOptions.includedIntegrations` 配置项参考文档"
src/content/docs/zh-cn/package-catalog/studiocms-plugins/studiocms-blog.mdx (1)

13-14: Ensure consistent semicolons and quoting.
The first import is missing a semicolon, and the <PackageManagers> attributes mix single quotes. For consistency:

-import { PackageManagers } from 'starlight-package-managers'
+import { PackageManagers } from 'starlight-package-managers';

-   <PackageManagers pkg="studiocms" type='run' args='add @studiocms/blog' />
+   <PackageManagers pkg="studiocms" type="run" args="add @studiocms/blog" />

Also applies to: 24-24

src/content/docs/zh-cn/config-reference/overrides.mdx (2)

1-7: Refine the page title for clarity
The frontmatter title: "配置覆盖" could be more idiomatic as “覆盖配置” to match terminology in other docs.


95-95: Adjust heading level for Best Practices
Change the “### 最佳实践:” heading to “## 最佳实践” so it aligns with other top-level sections on this page.

src/content/docs/zh-cn/config-reference/index.mdx (3)

11-11: Refine the main heading wording
“StudioCMS 集成配置选项架构参考” reads a bit clunky; consider “StudioCMS 配置选项架构参考”或“StudioCMS 配置参考指南”以提升可读性。


36-38: Clarify dbStartPage description
“项目初始化页面 - 用于首次设置时创建数据库配置。”中的“项目初始化页面”可能引起歧义,建议改为“数据库启动页”或“数据库设置页面”。


16-16: Add punctuation to default values comment
建议在代码注释末尾添加全角冒号,将

// 以下为默认值示例

改为

// 以下为默认值示例:
src/content/docs/zh-cn/config-reference/sdk.mdx (3)

3-5: Standardize the acronym casing
description: "StudioCMSOptions sdk 参考文档" 中的 sdk 修改为大写 SDK,保持与标题一致:

- description: "StudioCMSOptions sdk 参考文档"
+ description: "StudioCMSOptions SDK 参考文档"

11-11: Refine the main heading wording
“StudioCMS 集成配置选项架构参考”可优化为“StudioCMS SDK 缓存配置参考”或“StudioCMS SDK 配置指南”,以突出本页主题。


80-91: Annotate advanced example for consistency
高级缓存示例缺少 twoslash 和标题信息。建议如下:

- ```ts
+ ```ts twoslash title="高阶缓存配置示例"
  // 高级缓存配置示例(仅适用于Enterprise版本)
  cacheConfig: {
      lifetime: '10m',
      strategy: 'stale-while-revalidate', // 后台更新策略
      types: {
          api: '5m',
          database: '10m',
          assets: '24h'
      }
  }

</blockquote></details>
<details>
<summary>src/content/docs/zh-cn/config-reference/default-frontend-config.mdx (3)</summary><blockquote>

`11-11`: **Refine the main heading wording**  
“StudioCMS 集成配置选项架构参考”建议改为“StudioCMS 默认前端配置参考”以更聚焦页面内容。

---

`26-28`: **Enhance type description clarity**  
将 "`favicon` 是用于设置网站图标路径的字符串。" 调整为更标准的表述,例如:  
```md
`favicon` 是用于设置网站图标路径的字符串类型。

95-99: Normalize indentation in HeadConfig example
HeadConfig 代码示例中缩进混用制表符和空格,建议统一为两个空格(或四个空格)。

src/content/docs/zh-cn/guides/contributing/code-contributions.mdx (2)

15-18: Clarify the "解决现有问题" section title
建议将 “解决现有问题” 改为 “查找并解决现有问题” 以更清晰地传达上下文。


30-31: Enhance step clarity by linking .prototools
第 2 步提及 [.prototools] 文件,建议在文本中添加直接链接:

- **安装或更新 Node.js 和 pnpm**,版本需符合 [`.prototools`](https://github.com/withstudiocms/studiocms/blob/main/.prototools) 中的要求
src/content/docs/zh-cn/start-here/why-studioCMS.mdx (1)

9-15: Consider adding a table of contents.
For consistency with longer locale pages (e.g., the CLI guide), you might include a tableOfContents section in the frontmatter to enable in-page navigation.

src/content/docs/zh-cn/how-it-works/cli.mdx (2)

5-9: YAML frontmatter indentation.
Nested keys under sidebar are indented by 3 spaces. While valid, using a 2-space indent (as in other docs) improves readability and consistency.


28-44: Code block syntax highlighting.
The CLI examples use “log”. Consider switching these to “bash” or “```sh” so that syntax highlighting better matches shell commands.

src/content/docs/zh-cn/plugins/index.mdx (1)

214-215: Heading and type name mismatch.
The section heading AuthProvider does not match the code snippet type AuthProviders. Update the heading to AuthProviders for consistency.

src/content/docs/zh-cn/config-reference/dashboard.mdx (3)

9-9: Remove unused import.
The ReadMore component is imported but never used in this document. Please remove the import to avoid dead code.


48-54: Property name casing mismatch.
The heading ## \DashboardRouteOverride`should reflect the actual propertydashboardRouteOverride` (camelCase). Please adjust the heading.


3-5: Enhance description formatting.
In the frontmatter description, consider marking dashboardConfig with backticks (\dashboardConfig``) to clearly denote the config key.

src/content/docs/zh-cn/guides/upgrade/version-guides/0-1-0-beta-17.mdx (1)

10-10: Remove unused import.
import ReadMore is declared but never used in this guide. Please remove it for clarity.

src/content/docs/zh-cn/package-catalog/studiocms-plugins/studiocms-devapps.mdx (1)

22-49: Optional: Improve list nesting within TabItem

Inside <TabItem> components, the numbered lists and code fences are not indented. For more predictable MDX list rendering, consider indenting list items and their code blocks by two spaces to ensure they render as nested lists under the TabItem.

src/content/docs/zh-cn/start-here/environment-variables.mdx (1)

5-7: Nitpick: Align frontmatter indentation

In the YAML frontmatter, order: 2 is indented by three spaces under sidebar:. For consistency with other MDX files, please use two spaces for indentation under sidebar:.

src/content/docs/zh-cn/guides/upgrade/version-guides/0-1-0-beta-18.mdx (1)

49-54: Nitpick: Specify Aside type for consistency

The <Aside> block for the security reminder lacks a type attribute. Other docs use type="note". Consider adding type="note" for a consistent warning style:

-<Aside title="安全提醒">
+<Aside type="note" title="安全提醒">
src/content/docs/zh-cn/guides/database/sqld-server.mdx (1)

13-14: Improve phrasing of “关于”

LanguageTool suggests that "了解更多关于 sqld 的信息" can be smoothed to "了解更多有关 sqld 的信息" or rephrased at the sentence start. Please adjust for more natural Chinese.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~13-~13: “关于”组成的介词短语必需位于句首,或请改用"对于"代替。
Context: ...MS 项目。 通过[官方文档][sql-docs]了解更多关于 sqld 的信息 ## 先决条件 - [Dock...

(wb2)

src/content/docs/zh-cn/plugins/extended.mdx (1)

12-14: Add missing semicolons for consistency
The import statements in MDX should consistently end with semicolons, matching other docs.

-import ReadMore from '~/components/ReadMore.astro'
+import ReadMore from '~/components/ReadMore.astro';
-import { FileTree } from '@astrojs/starlight/components'
+import { FileTree } from '@astrojs/starlight/components';
src/content/docs/zh-cn/guides/contributing/translations.mdx (1)

24-27: Inconsistent admonition syntax
This file mixes :::tip MDX admonitions, whereas other docs use the <Aside> component. For uniform rendering, prefer:

<Aside type="tip" title="无法访问 Discord?">
  …内容…
</Aside>
-:::tip[无法访问 Discord?]
-我们依然欢迎您的参与!请在 GitHub 上为[文档](https://github.com/withstudiocms/docs/issues/new/choose)或[核心包](https://github.com/withstudiocms/studiocms/issues/new/choose)创建新问题提问。
-:::
+<Aside type="tip" title="无法访问 Discord?">
+  我们依然欢迎您的参与!请在 GitHub 上为[文档](https://github.com/withstudiocms/docs/issues/new/choose)或[核心包](https://github.com/withstudiocms/studiocms/issues/new/choose)创建新问题提问。
+</Aside>
src/content/docs/zh-cn/start-here/getting-started.mdx (1)

1-7: Consider adding a top-level heading
The frontmatter sets title: 快速入门指南, but the content starts at level-2 headings. For better accessibility and consistency, insert:

# 快速入门指南

directly beneath the frontmatter.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fc423f0 and 1ae4231.

📒 Files selected for processing (41)
  • astro.config.mts (1 hunks)
  • lunaria.config.ts (1 hunks)
  • src/content/docs/zh-cn/config-reference/dashboard.mdx (1 hunks)
  • src/content/docs/zh-cn/config-reference/default-frontend-config.mdx (1 hunks)
  • src/content/docs/zh-cn/config-reference/image-service.mdx (1 hunks)
  • src/content/docs/zh-cn/config-reference/included-integrations.mdx (1 hunks)
  • src/content/docs/zh-cn/config-reference/index.mdx (1 hunks)
  • src/content/docs/zh-cn/config-reference/overrides.mdx (1 hunks)
  • src/content/docs/zh-cn/config-reference/sdk.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/contributing/code-contributions.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/contributing/getting-started.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/contributing/translations.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/database/sqld-server.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/index.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/upgrade/release-notes.md (1 hunks)
  • src/content/docs/zh-cn/guides/upgrade/version-guides/0-1-0-beta-16.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/upgrade/version-guides/0-1-0-beta-17.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/upgrade/version-guides/0-1-0-beta-18.mdx (1 hunks)
  • src/content/docs/zh-cn/how-it-works/cli.mdx (1 hunks)
  • src/content/docs/zh-cn/how-it-works/index.mdx (1 hunks)
  • src/content/docs/zh-cn/how-it-works/restapi.mdx (1 hunks)
  • src/content/docs/zh-cn/how-it-works/sdk.mdx (1 hunks)
  • src/content/docs/zh-cn/index.mdx (1 hunks)
  • src/content/docs/zh-cn/package-catalog/community-plugins/web-vitals.mdx (1 hunks)
  • src/content/docs/zh-cn/package-catalog/index.mdx (1 hunks)
  • src/content/docs/zh-cn/package-catalog/studiocms-plugins/studiocms-blog.mdx (1 hunks)
  • src/content/docs/zh-cn/package-catalog/studiocms-plugins/studiocms-devapps.mdx (1 hunks)
  • src/content/docs/zh-cn/package-catalog/studiocms-plugins/studiocms-markdoc.mdx (1 hunks)
  • src/content/docs/zh-cn/package-catalog/studiocms-plugins/studiocms-mdx.mdx (1 hunks)
  • src/content/docs/zh-cn/package-catalog/studiocms-plugins/studiocms-wysiwyg.mdx (1 hunks)
  • src/content/docs/zh-cn/plugins/extended.mdx (1 hunks)
  • src/content/docs/zh-cn/plugins/index.mdx (1 hunks)
  • src/content/docs/zh-cn/start-here/configuration.mdx (1 hunks)
  • src/content/docs/zh-cn/start-here/environment-variables.mdx (1 hunks)
  • src/content/docs/zh-cn/start-here/gallery.mdx (1 hunks)
  • src/content/docs/zh-cn/start-here/getting-started.mdx (1 hunks)
  • src/content/docs/zh-cn/start-here/why-studioCMS.mdx (1 hunks)
  • src/content/docs/zh-cn/utils/rendering.mdx (1 hunks)
  • src/content/i18n/zh-cn.json (1 hunks)
  • src/starlight-sidebar/availTranslations.ts (1 hunks)
  • src/starlight-sidebar/zh-cn.json (1 hunks)
🧰 Additional context used
🪛 Biome (1.9.4)
src/starlight-sidebar/zh-cn.json

[error] 1-1: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 1-2: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 2-2: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 2-2: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 2-2: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 2-3: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 3-3: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 3-4: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 4-4: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 4-4: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 4-4: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 4-5: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 5-5: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 5-6: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 6-6: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 6-6: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 6-7: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 7-7: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 7-7: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 8-8: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 8-8: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 8-9: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 9-9: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 9-9: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 9-9: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 9-9: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 9-9: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 9-10: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 10-10: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 10-10: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 10-10: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 10-11: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 11-11: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 11-12: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 12-12: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 12-12: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 12-13: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 13-13: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 13-13: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 13-14: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 14-14: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 14-15: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 15-15: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 15-15: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 15-15: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 15-16: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 16-16: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 16-16: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 16-17: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 17-17: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 17-17: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 17-18: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 18-18: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 18-19: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 19-19: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 19-20: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 20-20: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 20-20: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 20-20: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 21-21: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 21-21: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 21-21: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 21-21: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 21-21: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 21-21: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 21-21: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 21-21: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 21-21: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 21-21: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 21-21: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 21-21: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 21-21: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 21-21: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 21-21: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 21-21: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 21-21: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 21-21: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 21-21: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 21-21: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)

🪛 LanguageTool
src/content/docs/zh-cn/package-catalog/index.mdx

[style] ~16-~16: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...t="Publicly Usable" variant="caution"/> is able to be installed and used in projects that ...

(BE_ABLE_TO)


[style] ~16-~16: Avoid the passive voice after ‘to be able to’.
Context: ... Usable" variant="caution"/> is able to be installed and used in projects that do not rely o...

(ABLE_TO_PASSIVE)

src/content/docs/zh-cn/guides/database/sqld-server.mdx

[uncategorized] ~13-~13: “关于”组成的介词短语必需位于句首,或请改用"对于"代替。
Context: ...MS 项目。 通过[官方文档][sql-docs]了解更多关于 sqld 的信息 ## 先决条件 - [Dock...

(wb2)

src/content/docs/zh-cn/how-it-works/restapi.mdx

[uncategorized] ~35-~35: A punctuation mark might be missing here.
Context: ...: | 端点路径 | 功能说明 | |---------|---------| | `GET /studiocms_api/rest/v1/public/fol...

(AI_EN_LECTOR_MISSING_PUNCTUATION)

src/content/docs/zh-cn/guides/upgrade/release-notes.md

[uncategorized] ~33-~33: You might be missing the article “a” here.
Context: ...github.com/Adammatthiesen)! - Implement new feedback system in the dashboard - [#5...

(AI_EN_LECTOR_MISSING_DETERMINER_A)


[uncategorized] ~59-~59: A punctuation mark might be missing here.
Context: ...b.com/withstudiocms/studiocms/pull/553) [ae8cdfc](https://github.com/withstudio...

(AI_EN_LECTOR_MISSING_PUNCTUATION)


[uncategorized] ~67-~67: A punctuation mark might be missing here.
Context: ...b.com/withstudiocms/studiocms/pull/522) [de1dbec](https://github.com/withstudio...

(AI_EN_LECTOR_MISSING_PUNCTUATION)


[uncategorized] ~75-~75: A punctuation mark might be missing here.
Context: ...b.com/withstudiocms/studiocms/pull/528) [d3674d6](https://github.com/withstudio...

(AI_EN_LECTOR_MISSING_PUNCTUATION)


[misspelling] ~150-~150: Did you mean the phrasal verb “clean up” instead of the noun ‘cleanup’?
Context: ... Refactor internal integration logic to cleanup old logic and simplify main integration...

(CLEAN_UP)


[uncategorized] ~158-~158: You might be missing the article “the” here.
Context: ...hiesen)! - Update Diff page - Update pageMetaData section to use disabled inputs to displ...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~163-~163: You might be missing the article “the” here.
Context: ...://github.com/Adammatthiesen)! - Remove old testingAndDemoMode developer option a...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~163-~163: You might be missing the article “a” here.
Context: ...ngAndDemoModedeveloper option and add newdemoMode` option with a simple interfa...

(AI_EN_LECTOR_MISSING_DETERMINER_A)


[uncategorized] ~169-~169: You might be missing the article “the” here.
Context: .../github.com/Adammatthiesen)! - Refactor rendering system to rely on plugin PageTypes inst...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~173-~173: You might be missing the article “the” here.
Context: ...nges - Removed MDX, and MarkDoc from built-in renderer. These will be replaced by ...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~174-~174: A determiner appears to be missing. Consider inserting it.
Context: ... These will be replaced by plugins. - Rendering system is now directly tied into the pl...

(AI_EN_LECTOR_MISSING_DETERMINER)


[uncategorized] ~175-~175: A determiner appears to be missing. Consider inserting it.
Context: ...s the entire PageData from the SDK. - New Rendering Component is now able to auto...

(AI_EN_LECTOR_MISSING_DETERMINER)


[style] ~175-~175: As a shorter alternative for ‘able to’, consider using “can now”.
Context: ...om the SDK. - New Rendering Component is now able to auto adapt to the pageType's provided r...

(BE_ABLE_TO)


[uncategorized] ~175-~175: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ... New Rendering Component is now able to auto adapt to the pageType's provided renderer. (T...

(AUTO_HYPHEN)


[uncategorized] ~271-~271: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...n)! - Internal package organization, no user facing changes - [#459](https://github.com/wi...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[uncategorized] ~275-~275: You might be missing the article “a” here.
Context: ...github.com/Adammatthiesen)! - Implement basic email notifier system for User and Admi...

(AI_EN_LECTOR_MISSING_DETERMINER_A)


[uncategorized] ~286-~286: Possible missing comma found.
Context: ...tabase Schema Updates: - Added a new table StudioCMSMailerConfig to store SMTP mai...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~301-~301: A punctuation mark might be missing here.
Context: ...b.com/withstudiocms/studiocms/pull/446) [610b759](https://github.com/withstudio...

(AI_EN_LECTOR_MISSING_PUNCTUATION)


[uncategorized] ~303-~303: Possible missing comma found.
Context: ...s system is implemented in the dashboard but only the base locale ("en-us") is avail...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~331-~331: Loose punctuation mark.
Context: ...e64 16. - CMS_GITHUB_REDIRECT_URI`: NEW - Optional variable for GitHub Redi...

(UNLIKELY_OPENING_PUNCTUATION)


[misspelling] ~353-~353: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...Avatar />` component. (Will always show a empty profile icon until we setup the n...

(EN_A_VS_AN)


[grammar] ~353-~353: The word “setup” is a noun. The verb is spelled with a space.
Context: ...ways show a empty profile icon until we setup the new system for the front-end) - ...

(NOUN_VERB_CONFUSION)


[uncategorized] ~357-~357: Loose punctuation mark.
Context: ...te table schema: - StudioCMSUsers: Removed oAuth ID's from main user table...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~380-~380: Loose punctuation mark.
Context: ... ``` - StudioCMSOAuthAccounts: New table to handle all oAuth accounts ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~392-~392: Loose punctuation mark.
Context: ...); ``` - StudioCMSPermissions: Updated to use direct reference to user...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~403-~403: Loose punctuation mark.
Context: ...}); ``` - StudioCMSSiteConfig: Added new options for login page `...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~403-~403: You might be missing the article “the” here.
Context: ...ioCMSSiteConfig`: Added new options for login page ```ts export const Studio...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~449-~449: Loose punctuation mark.
Context: ...: - packages/studiocms/src/index.ts: Replaced the static sitemap integration...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~450-~450: Loose punctuation mark.
Context: ...diocms/src/lib/dynamic-sitemap/index.ts: Added the dynamicSitemap` function to ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~451-~451: Loose punctuation mark.
Context: ...ib/dynamic-sitemap/sitemap-index.xml.ts`: Created a new route to serve the sitema...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~455-~455: Loose punctuation mark.
Context: .../studiocms/src/schemas/plugins/index.ts`: Updated the plugin schema to include an...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~459-~459: Loose punctuation mark.
Context: ...- packages/studiocms_blog/src/index.ts: Updated the StudioCMS Blog plugin to in...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~460-~460: Loose punctuation mark.
Context: ...iocms_blog/src/routes/sitemap-md.xml.ts`: Added a new route to generate the sitem...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~461-~461: Loose punctuation mark.
Context: ...ms_blog/src/routes/sitemap-posts.xml.ts`: Added a new route to generate the sitem...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~496-~496: You might be missing the article “the” here.
Context: ...Implement User quick action toolbar for frontend when user's are logged in - [#333](htt...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~496-~496: Did you mean the plural noun “users” instead of the possessive?
Context: ... quick action toolbar for frontend when user's are logged in - [#333](https://github....

(APOS_ARE)


[uncategorized] ~513-~513: Loose punctuation mark.
Context: ...n/translations/) - @studiocms/auth`: - Update login/signup routes to uti...

(UNLIKELY_OPENING_PUNCTUATION)


[style] ~519-~519: Consider using a different verb for a more formal wording.
Context: ...ue-branch)! - Update Frontend logic and fix some small issues with rendering. - ...

(FIX_RESOLVE)


[uncategorized] ~531-~531: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ... BASIC version of our plugin system. Currently Supports: - Custom Settings Page ...

(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)


[uncategorized] ~544-~544: You might be missing the article “the” here.
Context: .../apps/create-issue-branch)! - Implement new StudioCMS SDK in @studiocms/core and in...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~548-~548: A punctuation mark might be missing here.
Context: ...b.com/withstudiocms/studiocms/pull/301) [ebc297f](https://github.com/withstudio...

(AI_EN_LECTOR_MISSING_PUNCTUATION)


[grammar] ~548-~548: This expression is usually spelled with a hyphen.
Context: ...nch)! - Update .d.ts file generation (non breaking) - [#333](https://github.com/withstudi...

(NON_ANTI_JJ)


[uncategorized] ~562-~562: You might be missing the article “the” here.
Context: ...ue-branch)! - Fix CSS issue that caused sidebar to flow off the screen - [#333](https:...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[style] ~570-~570: Using many exclamation marks might seem excessive (in this case: 126 exclamation marks for a text that’s 46930 characters long)
Context: ...s://github.com/apps/create-issue-branch)! - New REST API endpoints and Dashboard ...

(EN_EXCESSIVE_EXCLAMATION)


[uncategorized] ~586-~586: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...ove are behind authentication. There is the following PUBLIC endpoints that ONL...

(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)


[uncategorized] ~601-~601: Possible missing comma found.
Context: ...cies - Update readme, and package.json naming as well as references to Astro Studio t...

(AI_HYDRA_LEO_MISSING_COMMA)


[style] ~603-~603: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ferences to Astro Studio to AstroDB. - Update readmes to reflect new package name - ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[uncategorized] ~605-~605: Possible missing comma found.
Context: ...dme]: Update Astro Studio references to AstroDB as Studio is closing down. - [Refacto...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~669-~669: You might be missing the article “the” here.
Context: ...1.0-beta.5 - [Refactor/Rename]: Split main package into smaller packages and renam...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~669-~669: You might be missing the article “the” here.
Context: ...ackage into smaller packages and rename main package. This change will allow a be...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~675-~675: Loose punctuation mark.
Context: .... Renamed Packages: - studiocms`: The main package that users will downlo...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~676-~676: Loose punctuation mark.
Context: ... download and use. - @studiocms/blog: The StudioCMSBlog Plugin New Package...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~680-~680: Loose punctuation mark.
Context: ...d their purposes: - @studiocms/core: Core components and functions - `@stu...

(UNLIKELY_OPENING_PUNCTUATION)


[grammar] ~712-~712: A determiner may be missing.
Context: ...hiesenxyz/integration-utils` updated to newest version and fix usage (No user changes ...

(THE_SUPERLATIVE)


[grammar] ~716-~716: Did you mean “to exclude”?
Context: ...eded) - [Fix]: Remove now not needed exclude rules for `@matthiesenxyz/integration-u...

(MISSING_TO_BEFORE_A_VERB)

🪛 Gitleaks (8.26.0)
src/content/docs/zh-cn/start-here/getting-started.mdx

62-62: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

🪛 markdownlint-cli2 (0.17.2)
src/content/docs/zh-cn/guides/upgrade/release-notes.md

171-171: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4

(MD001, heading-increment)


188-188: Hard tabs
Column: 3

(MD010, no-hard-tabs)


194-194: Hard tabs
Column: 3

(MD010, no-hard-tabs)


203-203: Hard tabs
Column: 3

(MD010, no-hard-tabs)


204-204: Hard tabs
Column: 3

(MD010, no-hard-tabs)


205-205: Hard tabs
Column: 3

(MD010, no-hard-tabs)


220-220: Hard tabs
Column: 3

(MD010, no-hard-tabs)


226-226: Hard tabs
Column: 3

(MD010, no-hard-tabs)


233-233: Hard tabs
Column: 3

(MD010, no-hard-tabs)


234-234: Hard tabs
Column: 3

(MD010, no-hard-tabs)


235-235: Hard tabs
Column: 3

(MD010, no-hard-tabs)


279-279: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4

(MD001, heading-increment)


279-279: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)


284-284: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)


321-321: Bare URL used
null

(MD034, no-bare-urls)


323-323: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4

(MD001, heading-increment)


367-367: Hard tabs
Column: 6

(MD010, no-hard-tabs)


368-368: Hard tabs
Column: 6

(MD010, no-hard-tabs)


369-369: Hard tabs
Column: 6

(MD010, no-hard-tabs)


370-370: Hard tabs
Column: 6

(MD010, no-hard-tabs)


371-371: Hard tabs
Column: 6

(MD010, no-hard-tabs)


447-447: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)


453-453: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)


457-457: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)


467-467: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)


473-473: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)


479-479: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Generate Lunaria Overview
🔇 Additional comments (31)
src/starlight-sidebar/availTranslations.ts (1)

1-1: Approved: Added Simplified Chinese locale
Including 'zh-cn' in the Translations constant correctly aligns with the rest of the i18n setup.

astro.config.mts (1)

37-37: Enabled Simplified Chinese locale
Uncommenting 'zh-cn': { label: '简体中文', lang: 'zh-CN' } properly activates the Chinese locale in Astro’s configuration.

src/content/docs/zh-cn/start-here/gallery.mdx (1)

1-15: Looks good: Valid new Chinese gallery page
The frontmatter, imports, and <Gallery> component usage correctly set up an i18nReady MDX page for Simplified Chinese documentation.

src/content/docs/zh-cn/guides/index.mdx (1)

19-20:

Details

✅ Verification successful

Verify guide path for database section
The link points to /zh-cn/guides/database/sqld-server/. Please confirm the folder name is sqld-server (with a “d”) and not libsql-server as in English.


🏁 Script executed:

#!/bin/bash
# Verify that the database guide directory exists
fd -t d sqld-server

Length of output: 21


🏁 Script executed:

#!/bin/bash
# Check if the Chinese database guides directory exists
echo "Looking for zh-cn/guides/database directory:"
fd -t d database src/content/docs/zh-cn/guides

# If it exists, list its subdirectories
echo
echo "Contents of zh-cn/guides/database (if present):"
fd -t d "" src/content/docs/zh-cn/guides/database

# Check for various server folder names
echo
echo "Searching for 'sqld-server' under zh-cn/guides/database:"
fd -t d sqld-server src/content/docs/zh-cn/guides/database

echo
echo "Searching for 'libsql-server' under zh-cn/guides/database:"
fd -t d libsql-server src/content/docs/zh-cn/guides/database

echo
echo "Searching for 'sql-server' under zh-cn/guides/database:"
fd -t d sql-server src/content/docs/zh-cn/guides/database

Length of output: 949


🏁 Script executed:

#!/bin/bash
# List all .mdx files under the Chinese database guides
echo "Chinese .mdx files in zh-cn/guides/database:"
fd -e mdx "" src/content/docs/zh-cn/guides/database || true

echo
# List all files (any extension) under the Chinese database guides
echo "All files in zh-cn/guides/database:"
fd "" src/content/docs/zh-cn/guides/database || true

echo
# List all .mdx files under the English database guides
echo "English .mdx files in guides/database:"
fd -e mdx "" src/content/docs/guides/database || true

echo
# List server-related directories in the English database guides
echo "Server-related directories in guides/database:"
fd -t d "*server" src/content/docs/guides/database || true

echo
# Specifically check for libsql-server and sqld-server in English
echo "Looking for libsql-server directory in English guides:"
fd -t d libsql-server src/content/docs/guides/database || true

echo
echo "Looking for sqld-server directory in English guides:"
fd -t d sqld-server src/content/docs/guides/database || true

Length of output: 1575


Guide path confirmed – sqld-server is correct
The directory src/content/docs/zh-cn/guides/database/sqld-server.mdx exists, so the link /zh-cn/guides/database/sqld-server/ is accurate.

src/content/docs/zh-cn/start-here/configuration.mdx (6)

1-7: Frontmatter looks good
Metadata is complete and consistent with other pages (i18nReady, title, description, sidebar.order).


22-40: Astro config example is clear
The first astro.config.mjs snippet is properly fenced, uses ts twoslash, and demonstrates the integration setup.


48-59: FileTree component usage is correct
The <FileTree> block clearly illustrates the project structure and imports FileTree accordingly.


63-75: Second Astro config snippet is accurate
The simplified astro.config.mjs example aligns with the recommendation and is formatted correctly.


77-84: StudioCMS config example is correct
The studiocms.config.mjs snippet demonstrates the dedicated config file usage and matches the narrative.


86-87: Reference link defined
The [reference-page] link is properly declared and used above in the <ReadMore> component.

src/content/docs/zh-cn/utils/rendering.mdx (4)

1-7: Validate frontmatter consistency and locale readiness.
Ensure the YAML frontmatter keys (i18nReady, title, description, sidebar.order) match other zh-CN docs for consistency (e.g., ordering, naming). Confirm that the sidebar.order value correctly places this page within the docs navigation.


13-18: Verify import paths and SDK alias usage.
The example imports StudioCMSRenderer from 'studiocms:renderer' and the SDK from 'studiocms:sdk'. Please confirm that these Vite/alias paths resolve correctly in the Astro project (vs. e.g. 'studiocms/renderer').


25-29: Check redirect behavior for missing pages.
The sample uses Astro.redirect('/404'). Confirm that your routing setup has a static /404 page; otherwise, this may lead to an uncaught redirect or 404 loop.


34-38: Approve layout wrapper usage.
The <Layout> wrapper correctly passes title, description, and heroImage and wraps <StudioCMSRenderer>. Indentation looks consistent after fixing tabs.

src/content/docs/zh-cn/package-catalog/studiocms-plugins/studiocms-wysiwyg.mdx (2)

23-25: Verify the <PackageManagers> component usage.
The prop pkg="studiocms" looks unconventional—typically this represents the package manager CLI (e.g., npm, pnpm, yarn). Please confirm that "studiocms" is valid here and produces the correct install command.


28-36: Ensure code block fence and Twoslash syntax are correct.
You’re using four backticks to wrap a triple-backtick snippet with twoslash. Confirm that the MDX parser supports this fence style and that the highlight annotations ({2, 6}) map to the intended lines in studiocms.config.mjs.

src/content/i18n/zh-cn.json (1)

42-43: Review translation accuracy for docsearch.footer.searchByText.
The current value "搜索技术支持" translates to "search technical support," which may not match the original context ("Search by …"). Please verify and adjust to something like "由 … 提供搜索" if needed.

src/content/docs/zh-cn/package-catalog/community-plugins/web-vitals.mdx (3)

1-11: Validate frontmatter fields and badge style.
The sidebar.badge.variant is set to 'tip'; confirm that this aligns with other community plugin badges. Also ensure catalogEntry: astrojs-web-vitals matches the slug used in your package catalog index.


13-16: Confirm asset import aliases.
The MDX file imports from ~/components/Gallery.astro and ~/assets/index.ts. Please verify that the ~ alias is configured in astro.config.mts and resolves correctly at build time.


46-49: Check code block highlight annotations.
The manual installation snippet uses ins={4, 13} alongside {12} for highlighting—validate that these annotations correspond to real line numbers in astro.config.mjs and render as expected in the docs.

src/content/docs/zh-cn/guides/contributing/getting-started.mdx (2)

1-7: Ensure frontmatter completeness.
The sidebar.order is set to 1; confirm this ordering among sibling pages to avoid navigation inconsistencies in the contributor guide section.


8-10: Verify import path for ContributorList.
The import uses ~/components/ContributorList.astro; ensure the alias ~ is properly configured and that this file exists at the expected location.

src/content/docs/zh-cn/guides/upgrade/version-guides/0-1-0-beta-16.mdx (3)

1-8: Front matter configuration looks good.
The i18nReady flag and metadata (title, description, sidebar) are correctly set for this new upgrade guide.


10-14: Component imports and usage are correct.
ReadMore and QuickUpdate are properly imported and used in the document.


15-21: Major changes section is clear and accurate.
The translation of the “重大变更” items is precise, and the content matches upstream release notes.

src/content/docs/zh-cn/config-reference/default-frontend-config.mdx (1)

66-67: Verify the HeadConfig anchor
链接 HeadConfig[] 时,请确认 #headconfig 对应的锚点名称与自动生成的一致。

src/content/docs/zh-cn/guides/contributing/code-contributions.mdx (1)

63-64:

Details

✅ Verification successful

Verify the [contributors] link anchor
请确认目标文档 /zh-cn/guides/contributing/getting-started/ 中确实存在 #我们的贡献者 锚点。


🏁 Script executed:

#!/bin/bash
# Check if the anchor exists in the getting-started page
rg -n "#我们的贡献者" src/content/docs/zh-cn/guides/contributing/getting-started.mdx

Length of output: 80


🏁 Script executed:

#!/bin/bash
# Search for any mention of '我们的贡献者' to verify if a heading or anchor exists
rg -n "我们的贡献者" src/content/docs/zh-cn/guides/contributing/getting-started.mdx || echo "No occurrences found"

Length of output: 159


确认 [contributors] 链接锚点有效
src/content/docs/zh-cn/guides/contributing/getting-started.mdx 第 16 行已定义了:

## 我们的贡献者

该标题会生成 id="我们的贡献者" 的锚点,与链接 /zh-cn/guides/contributing/getting-started/#我们的贡献者 完全匹配,无需修改。

src/content/docs/zh-cn/start-here/why-studioCMS.mdx (1)

1-7: Frontmatter configuration is solid.
The i18nReady, title, description, and sidebar.order fields align well with other localized docs.

src/content/docs/zh-cn/package-catalog/studiocms-plugins/studiocms-devapps.mdx (1)

13-15: Verify PackageManagers import path consistency

The PackageManagers component is imported from 'starlight-package-managers' here, but in other Chinese docs (e.g., sqld-server) it's imported from 'studiocms-package-managers'. Please confirm and unify the import source across all MDX files to avoid runtime errors or confusion.

src/content/docs/zh-cn/guides/database/sqld-server.mdx (1)

7-9: Verify PackageManagers import path consistency

Similar to the devapps doc, PackageManagers here is imported from 'studiocms-package-managers'. Ensure this matches the actual component package and is consistent across all Chinese docs.

src/content/docs/zh-cn/how-it-works/restapi.mdx (1)

1-7: Chinese REST API guide looks solid

The frontmatter, structure, and content are well-organized and clearly written. I have no issues to raise.

Comment thread lunaria.config.ts
Comment thread src/starlight-sidebar/zh-cn.json Outdated
Comment thread src/content/docs/zh-cn/package-catalog/index.mdx Outdated
Comment thread src/content/docs/zh-cn/package-catalog/index.mdx
Comment thread src/content/docs/zh-cn/package-catalog/studiocms-plugins/studiocms-blog.mdx Outdated
Comment thread src/content/docs/zh-cn/plugins/index.mdx Outdated
Comment thread src/content/docs/zh-cn/plugins/extended.mdx
Comment thread src/content/docs/zh-cn/how-it-works/sdk.mdx Outdated
Comment thread src/content/docs/zh-cn/how-it-works/index.mdx
Comment thread src/content/docs/zh-cn/guides/upgrade/release-notes.md Outdated
@Adammatthiesen
Copy link
Copy Markdown
Member

@jenxi Looks like there is some deployment issues,

2025-Jun-03 12:21:09.675776
#13 6.440 Failed to parse JSON file, invalid JSON syntax found at position 24
2025-Jun-03 12:21:09.675776
#13 6.440   Location:
2025-Jun-03 12:21:09.675776
#13 6.440     /app/src/starlight-sidebar/zh-cn.json:1:25

Wondering, are you testing locally at all? Might be a good idea to ensure nothing gets messed up syntax wise with this many changes.

@jenxi
Copy link
Copy Markdown
Contributor Author

jenxi commented Jun 5, 2025

2025-Jun-03 12:21:09.675776
#13 6.440 Failed to parse JSON file, invalid JSON syntax found at position 24
2025-Jun-03 12:21:09.675776
#13 6.440   Location:
2025-Jun-03 12:21:09.675776
#13 6.440     /app/src/starlight-sidebar/zh-cn.json:1:25

Wondering, are you testing locally at all? Might be a good idea to ensure nothing gets messed up syntax wise with this many changes.

@Adammatthiesen Yeah, it worked when running in dev. The opening tag somehow got removed after.

I just noticed that the other locales didn’t translate src/content/docs/zh-cn/guides/upgrade/release-notes.md, probably since it’s auto-generated, so I’ve removed it.

Comment thread src/content/docs/zh-cn/guides/database/sqld-server.mdx Outdated
Copy link
Copy Markdown
Contributor

@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: 1

♻️ Duplicate comments (2)
src/content/docs/zh-cn/plugins/extended.mdx (1)

1-10: Align frontmatter title with document heading
Frontmatter title: 构建高效插件 does not match the first heading # 插件开发指南. Please make them identical for consistency (e.g., change frontmatter to title: "插件开发指南").

src/content/docs/zh-cn/how-it-works/index.mdx (1)

1-9: Heading vs frontmatter title mismatch
Frontmatter title: "核心集成架构" does not match the first heading # 架构解析. Please align them for consistency.

🧹 Nitpick comments (11)
src/content/docs/zh-cn/config-reference/overrides.mdx (3)

1-7: Add a top-level heading for consistency
The document currently lacks a visible markdown heading matching the frontmatter title. Add # 配置覆盖 after the frontmatter to improve readability.


4-4: Refine description field for natural Chinese
Change description: "StudioCMSOptions overrides 参考文档" to description: "StudioCMSOptions 覆盖配置参考文档" for smoother phrasing.


11-11: Convert text into a proper markdown heading
The line StudioCMS 集成配置选项架构参考 should be prefixed with ## (or an appropriate level) to stand out as a section heading.

src/content/docs/zh-cn/how-it-works/restapi.mdx (2)

3-9: Ensure frontmatter title matches first heading
Frontmatter title: "REST API 开发指南" differs from the first heading # 技术导览. Consider renaming one to match the other.


11-11: Improve parallel structure in Chinese
建议在“简洁灵活的实现方案”中加入逗号,改为“简洁、灵活的实现方案”以增强可读性。

🧰 Tools
🪛 LanguageTool

[uncategorized] ~11-~11: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:灵活"地"实现
Context: ...基于 Astro DB 构建的这套 RESTful 接口,为内容操作提供简洁灵活的实现方案。 该 API 由 Astro Endpoints 技术驱动,提供标准...

(wb4)

src/content/docs/zh-cn/guides/database/sqld-server.mdx (2)

1-5: Add a main heading for this guide
The document lacks a markdown heading. Insert # 自托管 libSQL 服务器 below the frontmatter for clear structure.


13-13: Use more precise preposition
建议将“了解更多关于 sqld 的信息”改为“了解更多有关 sqld 的信息”。

🧰 Tools
🪛 LanguageTool

[uncategorized] ~13-~13: “关于”组成的介词短语必需位于句首,或请改用"对于"代替。
Context: ...MS 项目。 通过[官方文档][sql-docs]了解更多关于 sqld 的信息 ## 先决条件 - [Dock...

(wb2)

src/content/docs/zh-cn/start-here/getting-started.mdx (4)

9-14: Nit: Unify JSX prop quoting style
We mix single and double quotes in component props (e.g., type='tip' vs type="note"). Consider standardizing on one style for consistency.


21-21: Link to English docs
This bullet links to the English Astro docs (docs.astro.build/en/...). If there’s a Chinese mirror or translation available, consider updating it to the zh-CN version to maintain locale consistency.


36-38: Nit: Quote style in <Aside>
You’re using single quotes for type='tip' and title='…' here, whereas elsewhere double-quotes are used. Unify quoting across JSX for readability.


75-75: Link to English Astro guide
This "Astro 文档:远程 URL 配置选项" link points to the English docs. If a Chinese translation exists, swap it in to keep content localized.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between dcf9b8e and 4e8c23e.

📒 Files selected for processing (26)
  • src/content/docs/zh-cn/config-reference/index.mdx (1 hunks)
  • src/content/docs/zh-cn/config-reference/overrides.mdx (1 hunks)
  • src/content/docs/zh-cn/config-reference/sdk.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/contributing/code-contributions.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/contributing/getting-started.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/contributing/translations.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/database/sqld-server.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/upgrade/version-guides/0-1-0-beta-16.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/upgrade/version-guides/0-1-0-beta-17.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/upgrade/version-guides/0-1-0-beta-18.mdx (1 hunks)
  • src/content/docs/zh-cn/how-it-works/cli.mdx (1 hunks)
  • src/content/docs/zh-cn/how-it-works/index.mdx (1 hunks)
  • src/content/docs/zh-cn/how-it-works/restapi.mdx (1 hunks)
  • src/content/docs/zh-cn/index.mdx (1 hunks)
  • src/content/docs/zh-cn/package-catalog/community-plugins/web-vitals.mdx (1 hunks)
  • src/content/docs/zh-cn/package-catalog/studiocms-plugins/studiocms-blog.mdx (1 hunks)
  • src/content/docs/zh-cn/package-catalog/studiocms-plugins/studiocms-devapps.mdx (1 hunks)
  • src/content/docs/zh-cn/package-catalog/studiocms-plugins/studiocms-markdoc.mdx (1 hunks)
  • src/content/docs/zh-cn/package-catalog/studiocms-plugins/studiocms-mdx.mdx (1 hunks)
  • src/content/docs/zh-cn/package-catalog/studiocms-plugins/studiocms-wysiwyg.mdx (1 hunks)
  • src/content/docs/zh-cn/plugins/extended.mdx (1 hunks)
  • src/content/docs/zh-cn/plugins/index.mdx (1 hunks)
  • src/content/docs/zh-cn/start-here/configuration.mdx (1 hunks)
  • src/content/docs/zh-cn/start-here/environment-variables.mdx (1 hunks)
  • src/content/docs/zh-cn/start-here/getting-started.mdx (1 hunks)
  • src/content/docs/zh-cn/utils/rendering.mdx (1 hunks)
✅ Files skipped from review due to trivial changes (3)
  • src/content/docs/zh-cn/guides/upgrade/version-guides/0-1-0-beta-18.mdx
  • src/content/docs/zh-cn/config-reference/index.mdx
  • src/content/docs/zh-cn/start-here/environment-variables.mdx
🚧 Files skipped from review as they are similar to previous changes (17)
  • src/content/docs/zh-cn/package-catalog/studiocms-plugins/studiocms-blog.mdx
  • src/content/docs/zh-cn/package-catalog/studiocms-plugins/studiocms-mdx.mdx
  • src/content/docs/zh-cn/package-catalog/studiocms-plugins/studiocms-markdoc.mdx
  • src/content/docs/zh-cn/start-here/configuration.mdx
  • src/content/docs/zh-cn/config-reference/sdk.mdx
  • src/content/docs/zh-cn/guides/upgrade/version-guides/0-1-0-beta-16.mdx
  • src/content/docs/zh-cn/package-catalog/community-plugins/web-vitals.mdx
  • src/content/docs/zh-cn/guides/upgrade/version-guides/0-1-0-beta-17.mdx
  • src/content/docs/zh-cn/guides/contributing/getting-started.mdx
  • src/content/docs/zh-cn/index.mdx
  • src/content/docs/zh-cn/package-catalog/studiocms-plugins/studiocms-wysiwyg.mdx
  • src/content/docs/zh-cn/plugins/index.mdx
  • src/content/docs/zh-cn/utils/rendering.mdx
  • src/content/docs/zh-cn/guides/contributing/code-contributions.mdx
  • src/content/docs/zh-cn/how-it-works/cli.mdx
  • src/content/docs/zh-cn/package-catalog/studiocms-plugins/studiocms-devapps.mdx
  • src/content/docs/zh-cn/guides/contributing/translations.mdx
🧰 Additional context used
🪛 LanguageTool
src/content/docs/zh-cn/how-it-works/restapi.mdx

[uncategorized] ~11-~11: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:灵活"地"实现
Context: ...基于 Astro DB 构建的这套 RESTful 接口,为内容操作提供简洁灵活的实现方案。 该 API 由 Astro Endpoints 技术驱动,提供标准...

(wb4)

src/content/docs/zh-cn/guides/database/sqld-server.mdx

[uncategorized] ~13-~13: “关于”组成的介词短语必需位于句首,或请改用"对于"代替。
Context: ...MS 项目。 通过[官方文档][sql-docs]了解更多关于 sqld 的信息 ## 先决条件 - [Dock...

(wb2)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Generate Lunaria Overview
🔇 Additional comments (3)
src/content/docs/zh-cn/start-here/getting-started.mdx (3)

1-7: Frontmatter configuration looks good
The i18nReady, title, description, and sidebar configuration are correctly set for the Chinese locale.


254-256: Verify MDX code-fence meta syntax
The fence is annotated as `````json /--remote/ title="package.json"```` — ensure that /--remote/ is a supported highlight pattern in your MDX toolchain and is rendered as intended.


341-347: Verify link reference anchors
Double-check that all reference anchors (e.g. [db-url-token], [encryption-key], etc.) match actual heading slugs in the corresponding zh-CN pages so none of these end up broken.

Comment thread src/content/docs/zh-cn/start-here/getting-started.mdx Outdated
Copy link
Copy Markdown
Member

@Adammatthiesen Adammatthiesen left a comment

Choose a reason for hiding this comment

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

almost there from at-least the basics that i can help with

Comment thread src/content/docs/zh-cn/start-here/getting-started.mdx Outdated
@Adammatthiesen
Copy link
Copy Markdown
Member

@jenxi i also just noticed some of the UI translations are not working correctly which is strange...
image

@jenxi
Copy link
Copy Markdown
Contributor Author

jenxi commented Jun 7, 2025

@jenxi i also just noticed some of the UI translations are not working correctly which is strange...

Fixed this. The Guides & Tutorials items is still in English though, but that seems to be the case for the other languages as well.

@jenxi
Copy link
Copy Markdown
Contributor Author

jenxi commented Jun 12, 2025

Can’t seem to find the issue. The UI translations were working, but renaming the JSONs back to zh-CN.json broke those UI translations again.

@Adammatthiesen
Copy link
Copy Markdown
Member

okay well that seemed to clean up that issue, now on to the next

 validating links 
Error: 7 [ERROR] ✗ Found 13 invalid links in 8 files.
11:17:07 ▶ zh-cn/guides/
11:17:07   └─ /en/guides/upgrade/release-notes/ - inconsistent locale
11:17:07 ▶ zh-cn/config-reference/included-integrations/
11:17:07   └─ #robotsconfig - invalid hash
11:17:07 ▶ zh-cn/how-it-works/cli/
11:17:07   └─ #studiocms-upgrade - invalid hash
11:17:07 ▶ zh-cn/start-here/environment-variables/
11:17:07   └─ /zh-CN/start-here/getting-started/#optional-configure-oauth-authentication - invalid link
11:17:07 ▶ zh-cn/start-here/getting-started/
Error: 7 [ERROR] [starlight-links-validator-integration] An unhandled error occurred while running the "astro:build:done" hook
11:17:07   ├─ /zh-cn/start-here/environment-variables/#database-url-and-token-for-astrojsdb - invalid hash
11:17:07   ├─ /zh-cn/start-here/environment-variables/#database-url-and-token-for-astrojsdb - invalid hash
11:17:07   ├─ /zh-cn/start-here/environment-variables/#encryption-key-for-studiocmsauth - invalid hash
11:17:07   ├─ /zh-cn/start-here/environment-variables/#oauth-authentication-environment-variables - invalid hash
11:17:07   ├─ #configure-your-packagejson-scripts - invalid hash
11:17:07   └─ #first-time-setup-or-during-updates-if-the-tables-schema-is-updated - invalid hash
11:17:07 ▶ zh-cn/guides/database/sqld-server/
11:17:07   └─ /zh-cn/start-here/getting-started/#first-time-setup-or-during-updates-if-the-tables-schema-is-updated - invalid hash
11:17:07 ▶ zh-cn/guides/contributing/code-contributions/
11:17:07   └─ /zh-CN/guides/contributing/getting-started/#我们的贡献者 - invalid link
11:17:07 ▶ zh-cn/guides/contributing/translations/
11:17:07   └─ /zh-CN/config-reference/ - invalid link

Copy link
Copy Markdown
Contributor

@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: 2

♻️ Duplicate comments (2)
src/content/docs/zh-cn/start-here/getting-started.mdx (2)

15-15: Locale slug casing still incorrect
href should use /zh-CN/, not /zh-cn/. This has been flagged before.

-<LinkCard title="升级到最新版 StudioCMS" href="/zh-cn/guides/upgrade/latest/" description="需要升级到最新版本?请查看这里!" />
+<LinkCard title="升级到最新版 StudioCMS" href="/zh-CN/guides/upgrade/latest/" description="需要升级到最新版本?请查看这里!" />

341-348: Footer references still use /zh-cn/ and contain localhost URLs
Update the locale slug and remove hard-coded localhost domains to avoid broken links.

-[package-catalog]: /zh-cn/package-catalog/
-[environment-variables]: /zh-cn/start-here/environment-variables/
-[config-reference]: /zh-cn/config-reference/
-[db-url-token]: /zh-cn/start-here/environment-variables/#astrojsdb-数据库连接参数
-[encryption-key]: /zh-cn/start-here/environment-variables/#studiocmsauth-加密密钥
-[oauth-environment-variables]: /zh-cn/start-here/environment-variables/#oauth-认证环境变量
-[auth-config-ref]: /zh-cn/config-reference/dashboard/#authconfig
-[self-hosted-libsql]: /zh-cn/guides/database/sqld-server/
+[package-catalog]: /zh-CN/package-catalog/
+[environment-variables]: /zh-CN/start-here/environment-variables/
+[config-reference]: /zh-CN/config-reference/
+[db-url-token]: /zh-CN/start-here/environment-variables/#astrojsdb-数据库连接参数
+[encryption-key]: /zh-CN/start-here/environment-variables/#studiocmsauth-加密密钥
+[oauth-environment-variables]: /zh-CN/start-here/environment-variables/#oauth-认证环境变量
+[auth-config-ref]: /zh-CN/config-reference/dashboard/#authconfig
+[self-hosted-libsql]: /zh-CN/guides/database/sqld-server/
🧹 Nitpick comments (3)
src/content/docs/zh-cn/config-reference/included-integrations.mdx (1)

11-11: Add a heading marker for clarity & TOC integration
Line 11 is plain text, so it will not appear in Starlight’s generated table-of-contents. Prefix it with ## (or a desired level) to make it an actual heading.

-StudioCMS 集成配置选项架构参考
+## StudioCMS 集成配置选项架构参考
src/content/docs/zh-cn/guides/database/sqld-server.mdx (1)

13-14: Minor wording tweak to silence LanguageTool & improve flow
“了解更多关于” → “了解更多有关”,避免介词短语位置警告并读起来更自然.

-<ReadMore>通过[官方文档][sql-docs]了解更多关于 `sqld` 的信息</ReadMore>
+<ReadMore>通过[官方文档][sql-docs]了解更多有关 `sqld` 的信息</ReadMore>
src/content/docs/zh-cn/start-here/getting-started.mdx (1)

61-63: Avoid committing realistic-looking secrets
Even though this is an example, static scanners flag the JWT string. Replace with a clearly fake placeholder to prevent CI false positives.

-ASTRO_DB_APP_TOKEN=eyJhbGciOiJF...3ahJpTkKDw
+ASTRO_DB_APP_TOKEN=<YOUR_APP_TOKEN>
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e0846c7 and 285e3a2.

📒 Files selected for processing (9)
  • src/content/docs/zh-cn/config-reference/included-integrations.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/contributing/code-contributions.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/contributing/translations.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/database/sqld-server.mdx (1 hunks)
  • src/content/docs/zh-cn/how-it-works/cli.mdx (1 hunks)
  • src/content/docs/zh-cn/start-here/environment-variables.mdx (1 hunks)
  • src/content/docs/zh-cn/start-here/getting-started.mdx (1 hunks)
  • src/content/i18n/zh-CN.json (1 hunks)
  • src/starlight-sidebar/zh-CN.json (1 hunks)
✅ Files skipped from review due to trivial changes (4)
  • src/content/i18n/zh-CN.json
  • src/starlight-sidebar/zh-CN.json
  • src/content/docs/zh-cn/start-here/environment-variables.mdx
  • src/content/docs/zh-cn/guides/contributing/translations.mdx
🚧 Files skipped from review as they are similar to previous changes (2)
  • src/content/docs/zh-cn/guides/contributing/code-contributions.mdx
  • src/content/docs/zh-cn/how-it-works/cli.mdx
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: ArmandPhilippot
PR: withstudiocms/docs#130
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-17.mdx:1-11
Timestamp: 2025-04-26T12:29:17.995Z
Learning: When reviewing translations in the withstudiocms/docs repository, compare with the corresponding English version as the source of truth, not with other files in the same target language. French translations should maintain structural parity with their English counterparts.
🪛 Gitleaks (8.26.0)
src/content/docs/zh-cn/start-here/getting-started.mdx

62-62: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

🪛 LanguageTool
src/content/docs/zh-cn/guides/database/sqld-server.mdx

[uncategorized] ~13-~13: “关于”组成的介词短语必需位于句首,或请改用"对于"代替。
Context: ...MS 项目。 通过[官方文档][sql-docs]了解更多关于 sqld 的信息 ## 先决条件 - [Dock...

(wb2)

🔇 Additional comments (1)
src/content/docs/zh-cn/config-reference/included-integrations.mdx (1)

25-28: Double-check the documented default & type for robotsTXT
The comment lists boolean | RobotsConfig | undefined and says the default is true. If the real default in code is false (quite common for opt-in features) or the boolean form isn’t supported, this doc will mislead users. Please verify against the actual implementation.

Comment thread src/content/docs/zh-cn/guides/database/sqld-server.mdx
Comment thread src/content/docs/zh-cn/start-here/getting-started.mdx
Copy link
Copy Markdown
Member

@Adammatthiesen Adammatthiesen left a comment

Choose a reason for hiding this comment

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

@jenxi I feel like this is getting close!

Comment on lines +345 to +346
[encryption-key]: /zh-cn/start-here/environment-variables/#http://localhost:4322/zh-cn/start-here/environment-variables/#studiocmsauth-加密密钥
[oauth-environment-variables]: /zh-cn/start-here/environment-variables/#http://localhost:4322/zh-cn/start-here/environment-variables/#oauth-认证环境变量
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

07:37:52 ▶ zh-cn/start-here/getting-started/
07:37:52   ├─ /zh-cn/start-here/environment-variables/#http://localhost:4322/zh-cn/start-here/environment-variables/#studiocmsauth-加密密钥 - invalid hash
07:37:52   └─ /zh-cn/start-here/environment-variables/#http://localhost:4322/zh-cn/start-here/environment-variables/#oauth-认证环境变量 - invalid hash

This is causing an error

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yeah, saw it too. Fixed it. Thanks!

Copy link
Copy Markdown
Contributor

@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: 2

♻️ Duplicate comments (1)
src/content/docs/zh-cn/how-it-works/sdk.mdx (1)

25-28: Update mismatched SDK object names

The narrative still uses studioCMSSDK / studioCMSSDKCached, but the import examples (and real API) expose SDK / SDKCached. Keeping the old names will confuse readers and break copy-paste usage.

-`studioCMSSDK` 对象提供了一套允许您与 StudioCMS 交互的函数和实用工具。您可以使用这些函数在 Astro 项目中创建、读取、更新和删除内容。
+`SDK` 对象提供了一套允许您与 StudioCMS 交互的函数和实用工具。您可以使用这些函数在 Astro 项目中创建、读取、更新和删除内容。

-`studioCMSSDKCached` 对象提供了一套函数和实用工具,允许您在 StudioCMS SDK 之上使用缓存层进行交互。您可以使用这些函数在 Astro 项目中缓存内容。
+`SDKCached` 对象提供了一套函数和实用工具,允许您在 StudioCMS SDK 之上使用缓存层进行交互。您可以使用这些函数在 Astro 项目中缓存内容。
🧹 Nitpick comments (2)
src/content/docs/zh-cn/how-it-works/sdk.mdx (1)

162-166: Quote the new property to silence lints

In TypeScript destructuring, the identifier new is legal but many linters flag reserved keywords. Quoting avoids false positives without altering behaviour.

-      new: newToken,
+      'new': newToken,
src/content/docs/zh-cn/start-here/getting-started.mdx (1)

197-198: Invisible zero-width space sneaked in

There’s a \u200B between “文件中的” and the back-ticked site, which can confuse copy-pastes and some Markdown renderers. Delete the hidden char.

-文件中的 ​`site` 配置项
+文件中的 `site` 配置项
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 285e3a2 and d40ddd5.

📒 Files selected for processing (13)
  • src/content/docs/zh-cn/config-reference/default-frontend-config.mdx (1 hunks)
  • src/content/docs/zh-cn/config-reference/index.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/index.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/upgrade/version-guides/0-1-0-beta-16.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/upgrade/version-guides/0-1-0-beta-17.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/upgrade/version-guides/0-1-0-beta-18.mdx (1 hunks)
  • src/content/docs/zh-cn/how-it-works/index.mdx (1 hunks)
  • src/content/docs/zh-cn/how-it-works/sdk.mdx (1 hunks)
  • src/content/docs/zh-cn/index.mdx (1 hunks)
  • src/content/docs/zh-cn/plugins/extended.mdx (1 hunks)
  • src/content/docs/zh-cn/plugins/index.mdx (1 hunks)
  • src/content/docs/zh-cn/start-here/configuration.mdx (1 hunks)
  • src/content/docs/zh-cn/start-here/getting-started.mdx (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • src/content/docs/zh-cn/config-reference/index.mdx
🚧 Files skipped from review as they are similar to previous changes (10)
  • src/content/docs/zh-cn/guides/index.mdx
  • src/content/docs/zh-cn/guides/upgrade/version-guides/0-1-0-beta-18.mdx
  • src/content/docs/zh-cn/guides/upgrade/version-guides/0-1-0-beta-16.mdx
  • src/content/docs/zh-cn/index.mdx
  • src/content/docs/zh-cn/start-here/configuration.mdx
  • src/content/docs/zh-cn/plugins/index.mdx
  • src/content/docs/zh-cn/config-reference/default-frontend-config.mdx
  • src/content/docs/zh-cn/guides/upgrade/version-guides/0-1-0-beta-17.mdx
  • src/content/docs/zh-cn/plugins/extended.mdx
  • src/content/docs/zh-cn/how-it-works/index.mdx
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: ArmandPhilippot
PR: withstudiocms/docs#130
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-17.mdx:1-11
Timestamp: 2025-04-26T12:29:17.995Z
Learning: When reviewing translations in the withstudiocms/docs repository, compare with the corresponding English version as the source of truth, not with other files in the same target language. French translations should maintain structural parity with their English counterparts.
🪛 LanguageTool
src/content/docs/zh-cn/how-it-works/sdk.mdx

[uncategorized] ~11-~11: 数量词修饰并列短语,可能产生歧义
Context: ...SDK 是一个强大的工具,允许您以编程方式与 StudioCMS 交互。它提供了一套函数和实用工具,使您能够使用 Astro DB 管理和提供内容。它同时也是 StudioCMS...

(s5)


[uncategorized] ~27-~27: 数量词修饰并列短语,可能产生歧义
Context: ...、读取、更新和删除内容。 studioCMSSDKCached 对象提供了一套函数和实用工具,允许您在 StudioCMS SDK 之上使用缓存层进行交互。您可以使用这些函...

(s5)

🪛 Gitleaks (8.26.0)
src/content/docs/zh-cn/start-here/getting-started.mdx

62-62: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

🔇 Additional comments (1)
src/content/docs/zh-cn/start-here/getting-started.mdx (1)

51-63: Ensure sample token is obviously non-production

Static-analysis flagged ASTRO_DB_APP_TOKEN=eyJhbGciOiJF...3ahJpTkKDw.
Looks like a truncated placeholder, which is fine, but double-check that no real secret slipped in before merging.

Comment thread src/content/docs/zh-cn/start-here/getting-started.mdx Outdated
Comment thread src/content/docs/zh-cn/start-here/getting-started.mdx Outdated
Copy link
Copy Markdown
Contributor

@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: 2

🧹 Nitpick comments (1)
src/content/docs/zh-cn/guides/database/sqld-server.mdx (1)

13-13: Minor wording – replace “关于” with “对于”

LanguageTool is right: “对于” fits better in this context.

-<ReadMore>通过[官方文档][sql-docs]了解更多关于 `sqld` 的信息</ReadMore>
+<ReadMore>通过[官方文档][sql-docs]了解更多对于 `sqld` 的信息</ReadMore>
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d40ddd5 and 41da800.

📒 Files selected for processing (6)
  • src/content/docs/zh-cn/guides/contributing/code-contributions.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/contributing/getting-started.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/contributing/translations.mdx (1 hunks)
  • src/content/docs/zh-cn/guides/database/sqld-server.mdx (1 hunks)
  • src/content/docs/zh-cn/how-it-works/cli.mdx (1 hunks)
  • src/content/docs/zh-cn/start-here/environment-variables.mdx (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • src/content/docs/zh-cn/guides/contributing/code-contributions.mdx
🚧 Files skipped from review as they are similar to previous changes (4)
  • src/content/docs/zh-cn/guides/contributing/getting-started.mdx
  • src/content/docs/zh-cn/how-it-works/cli.mdx
  • src/content/docs/zh-cn/start-here/environment-variables.mdx
  • src/content/docs/zh-cn/guides/contributing/translations.mdx
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: ArmandPhilippot
PR: withstudiocms/docs#130
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-17.mdx:1-11
Timestamp: 2025-04-26T12:29:17.995Z
Learning: When reviewing translations in the withstudiocms/docs repository, compare with the corresponding English version as the source of truth, not with other files in the same target language. French translations should maintain structural parity with their English counterparts.
🪛 LanguageTool
src/content/docs/zh-cn/guides/database/sqld-server.mdx

[uncategorized] ~13-~13: “关于”组成的介词短语必需位于句首,或请改用"对于"代替。
Context: ...MS 项目。 通过[官方文档][sql-docs]了解更多关于 sqld 的信息 ## 先决条件 - [Dock...

(wb2)

Comment thread src/content/docs/zh-cn/guides/database/sqld-server.mdx
Comment thread src/content/docs/zh-cn/guides/database/sqld-server.mdx Outdated
Copy link
Copy Markdown
Contributor

@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 (12)
src/content/docs/zh-CN/guides/contributing/translations.mdx (2)

32-35: Prefer Markdown image syntax for consistency & a11y

The raw <img> tag bypasses automatic optimisation, width inference and lazy-loading Starlight applies to ![alt](url) images.
Unless you need custom attributes, switch to Markdown so docs tooling can handle the asset.

-<img src="https://badges.awesome-crowdin.com/translation-16993424-776180-update.png" alt="翻译状态" />
+![翻译状态](https://badges.awesome-crowdin.com/translation-16993424-776180-update.png)

115-117: Internal link locale is hard-coded

/zh-CN/config-reference/ uses an absolute, locale-specific path. If a reader switches locale, the link won’t follow.
Consider the locale-aware helper (e.g. <LocalizedLink href="/config-reference/" />) or a relative link so Starlight rewrites it automatically.

src/content/docs/zh-CN/package-catalog/community-plugins/web-vitals.mdx (1)

24-35: Clean up large commented blocks

Three sizeable blocks ({/* <Steps> */}{/* </Steps> */} and the Gallery demo) are checked-in but inactive. Leaving them around bloats the MDX, hurts readability, and makes future translators uncertain whether they should translate or ignore the text.

If you intend to ship the feature soon, leave a TODO with an ETA; otherwise, drop the dead code to keep the docs lean.

Also applies to: 38-40, 74-76

src/content/docs/zh-CN/package-catalog/index.mdx (1)

10-16: Minor punctuation: remove double spaces after “。”

LanguageTool flags two places where an extra full-width space follows . This breaks Chinese typography rules and can cause awkward line-breaking.

-...验证和测试。  标记为<Badge text="插件"
+...验证和测试。标记为<Badge text="插件"

-...生产环境。  标记为<Badge text="公开可用"
+...生产环境。标记为<Badge text="公开可用"

Purely cosmetic, but worth fixing while we are here.

src/content/docs/zh-CN/guides/database/sqld-server.mdx (3)

13-14: Phrase order can be improved for native fluency

了解更多关于 … 的信息 is seldom used in technical writing. A more idiomatic wording is 了解有关 … 的更多信息.

-<ReadMore>通过[官方文档][sql-docs]了解更多关于 `sqld` 的信息</ReadMore>
+<ReadMore>阅读[官方文档][sql-docs],了解有关 `sqld` 的更多信息</ReadMore>

61-63: Warn readers not to commit secrets & suggest .env.example

The snippet leaves ASTRO_DB_APP_TOKEN blank, which may tempt newcomers to paste their real token into a committed file.
Recommend pointing users to a non-tracked .env or .env.example to mitigate accidental leakage.

-ASTRO_DB_APP_TOKEN= # 粘贴您的标准 JWT 认证令牌
+# ⚠️ 请勿将真实令牌提交到版本控制
+ASTRO_DB_APP_TOKEN=

103-104: Clarify that the value must be Base64URL-encoded

The placeholder text mixes Chinese and English and may confuse users about the exact format required by SQLD_AUTH_JWT_KEY.
Consider rephrasing to:

- SQLD_AUTH_JWT_KEY=<Base64URL-encoded JWT>
src/content/docs/zh-CN/how-it-works/restapi.mdx (2)

11-11: 标点与措辞微调,提升可读性
建议在“简洁”与“灵活”之间加顿号,符合中文书面表达习惯。

- 为内容操作提供简洁灵活的实现方案。
+ 为内容操作提供简洁、灵活的实现方案。

15-20: 补充示例以明确 Authorization 头格式
为避免集成方误用,最好给出完整示范,包括 Bearer 前缀。示例:

在请求头中添加:

```http
Authorization: Bearer <YOUR_API_TOKEN>

</blockquote></details>
<details>
<summary>src/content/docs/zh-CN/plugins/index.mdx (1)</summary><blockquote>

`31-35`: **代码片段缺少类型引入,可能导致读者复制即报错**  
`AstroIntegrationLogger` 与 `GridItemInput` 并非全局类型,示例里可加一行注释提醒从 `astro` 与 `studiocms/types` 引入,避免初学者踩坑。

</blockquote></details>
<details>
<summary>src/content/docs/zh-CN/start-here/getting-started.mdx (1)</summary><blockquote>

`60-63`: **示例令牌触发机密扫描,可替换为占位符**  
为避免误报泄漏,建议使用占位文本:  
```diff
-ASTRO_DB_APP_TOKEN=eyJhbGciOiJF...3ahJpTkKDw
+ASTRO_DB_APP_TOKEN=<YOUR_APP_TOKEN>
src/content/docs/zh-CN/how-it-works/sdk.mdx (1)

25-28: 对象命名不一致,可能混淆读者
文档中应保持与上方 import 一致:

-`studioCMSSDK` 对象提供…
+`SDK` 对象提供…
...
-`studioCMSSDKCached` 对象提供…
+`SDKCached` 对象提供…
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between decf34f and 89c3f8d.

📒 Files selected for processing (34)
  • src/content/docs/zh-CN/config-reference/dashboard.mdx (1 hunks)
  • src/content/docs/zh-CN/config-reference/default-frontend-config.mdx (1 hunks)
  • src/content/docs/zh-CN/config-reference/image-service.mdx (1 hunks)
  • src/content/docs/zh-CN/config-reference/included-integrations.mdx (1 hunks)
  • src/content/docs/zh-CN/config-reference/index.mdx (1 hunks)
  • src/content/docs/zh-CN/config-reference/overrides.mdx (1 hunks)
  • src/content/docs/zh-CN/config-reference/sdk.mdx (1 hunks)
  • src/content/docs/zh-CN/guides/contributing/code-contributions.mdx (1 hunks)
  • src/content/docs/zh-CN/guides/contributing/getting-started.mdx (1 hunks)
  • src/content/docs/zh-CN/guides/contributing/translations.mdx (1 hunks)
  • src/content/docs/zh-CN/guides/database/sqld-server.mdx (1 hunks)
  • src/content/docs/zh-CN/guides/index.mdx (1 hunks)
  • src/content/docs/zh-CN/guides/upgrade/version-guides/0-1-0-beta-16.mdx (1 hunks)
  • src/content/docs/zh-CN/guides/upgrade/version-guides/0-1-0-beta-17.mdx (1 hunks)
  • src/content/docs/zh-CN/guides/upgrade/version-guides/0-1-0-beta-18.mdx (1 hunks)
  • src/content/docs/zh-CN/how-it-works/cli.mdx (1 hunks)
  • src/content/docs/zh-CN/how-it-works/index.mdx (1 hunks)
  • src/content/docs/zh-CN/how-it-works/restapi.mdx (1 hunks)
  • src/content/docs/zh-CN/how-it-works/sdk.mdx (1 hunks)
  • src/content/docs/zh-CN/package-catalog/community-plugins/web-vitals.mdx (1 hunks)
  • src/content/docs/zh-CN/package-catalog/index.mdx (1 hunks)
  • src/content/docs/zh-CN/package-catalog/studiocms-plugins/studiocms-blog.mdx (1 hunks)
  • src/content/docs/zh-CN/package-catalog/studiocms-plugins/studiocms-devapps.mdx (1 hunks)
  • src/content/docs/zh-CN/package-catalog/studiocms-plugins/studiocms-markdoc.mdx (1 hunks)
  • src/content/docs/zh-CN/package-catalog/studiocms-plugins/studiocms-mdx.mdx (1 hunks)
  • src/content/docs/zh-CN/package-catalog/studiocms-plugins/studiocms-wysiwyg.mdx (1 hunks)
  • src/content/docs/zh-CN/plugins/extended.mdx (1 hunks)
  • src/content/docs/zh-CN/plugins/index.mdx (1 hunks)
  • src/content/docs/zh-CN/start-here/configuration.mdx (1 hunks)
  • src/content/docs/zh-CN/start-here/environment-variables.mdx (1 hunks)
  • src/content/docs/zh-CN/start-here/gallery.mdx (1 hunks)
  • src/content/docs/zh-CN/start-here/getting-started.mdx (1 hunks)
  • src/content/docs/zh-CN/start-here/why-studioCMS.mdx (1 hunks)
  • src/content/docs/zh-CN/utils/rendering.mdx (1 hunks)
✅ Files skipped from review due to trivial changes (24)
  • src/content/docs/zh-CN/start-here/gallery.mdx
  • src/content/docs/zh-CN/package-catalog/studiocms-plugins/studiocms-wysiwyg.mdx
  • src/content/docs/zh-CN/config-reference/image-service.mdx
  • src/content/docs/zh-CN/package-catalog/studiocms-plugins/studiocms-blog.mdx
  • src/content/docs/zh-CN/package-catalog/studiocms-plugins/studiocms-mdx.mdx
  • src/content/docs/zh-CN/guides/upgrade/version-guides/0-1-0-beta-18.mdx
  • src/content/docs/zh-CN/package-catalog/studiocms-plugins/studiocms-markdoc.mdx
  • src/content/docs/zh-CN/config-reference/overrides.mdx
  • src/content/docs/zh-CN/guides/contributing/code-contributions.mdx
  • src/content/docs/zh-CN/config-reference/included-integrations.mdx
  • src/content/docs/zh-CN/start-here/configuration.mdx
  • src/content/docs/zh-CN/guides/index.mdx
  • src/content/docs/zh-CN/config-reference/sdk.mdx
  • src/content/docs/zh-CN/guides/contributing/getting-started.mdx
  • src/content/docs/zh-CN/guides/upgrade/version-guides/0-1-0-beta-17.mdx
  • src/content/docs/zh-CN/start-here/why-studioCMS.mdx
  • src/content/docs/zh-CN/config-reference/index.mdx
  • src/content/docs/zh-CN/start-here/environment-variables.mdx
  • src/content/docs/zh-CN/package-catalog/studiocms-plugins/studiocms-devapps.mdx
  • src/content/docs/zh-CN/config-reference/default-frontend-config.mdx
  • src/content/docs/zh-CN/config-reference/dashboard.mdx
  • src/content/docs/zh-CN/how-it-works/cli.mdx
  • src/content/docs/zh-CN/how-it-works/index.mdx
  • src/content/docs/zh-CN/utils/rendering.mdx
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: ArmandPhilippot
PR: withstudiocms/docs#130
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-17.mdx:1-11
Timestamp: 2025-04-26T12:29:17.995Z
Learning: When reviewing translations in the withstudiocms/docs repository, compare with the corresponding English version as the source of truth, not with other files in the same target language. French translations should maintain structural parity with their English counterparts.
src/content/docs/zh-CN/guides/contributing/translations.mdx (1)
Learnt from: ArmandPhilippot
PR: withstudiocms/docs#130
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-17.mdx:1-11
Timestamp: 2025-04-26T12:29:17.995Z
Learning: When reviewing translations in the withstudiocms/docs repository, compare with the corresponding English version as the source of truth, not with other files in the same target language. French translations should maintain structural parity with their English counterparts.
🪛 LanguageTool
src/content/docs/zh-CN/how-it-works/restapi.mdx

[uncategorized] ~11-~11: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:灵活"地"实现
Context: ...基于 Astro DB 构建的这套 RESTful 接口,为内容操作提供简洁灵活的实现方案。 该 API 由 Astro Endpoints 技术驱动,提供标准...

(wb4)

src/content/docs/zh-CN/guides/database/sqld-server.mdx

[uncategorized] ~13-~13: “关于”组成的介词短语必需位于句首,或请改用"对于"代替。
Context: ...MS 项目。 通过[官方文档][sql-docs]了解更多关于 sqld 的信息 ## 先决条件 - [Dock...

(wb2)

src/content/docs/zh-CN/how-it-works/sdk.mdx

[uncategorized] ~11-~11: 数量词修饰并列短语,可能产生歧义
Context: ...SDK 是一个强大的工具,允许您以编程方式与 StudioCMS 交互。它提供了一套函数和实用工具,使您能够使用 Astro DB 管理和提供内容。它同时也是 StudioCMS...

(s5)


[uncategorized] ~27-~27: 数量词修饰并列短语,可能产生歧义
Context: ...、读取、更新和删除内容。 studioCMSSDKCached 对象提供了一套函数和实用工具,允许您在 StudioCMS SDK 之上使用缓存层进行交互。您可以使用这些函...

(s5)

src/content/docs/zh-CN/package-catalog/index.mdx

[uncategorized] ~12-~12: A punctuation mark might be missing here.
Context: ...出的所有软件包都经过 StudioCMS 团队或其贡献者的验证和测试。 标记为的软件包是用于扩展 StudioCMS 或其仪表板功能的包。 插件可能同时标记为<Badge t...

(AI_EN_LECTOR_MISSING_PUNCTUATION)


[uncategorized] ~16-~16: A punctuation mark might be missing here.
Context: ...其内部实现可能随时发生重大变更。此类插件也可能尚未准备好用于生产环境。 标记为的软件包可独立安装使用,无需依赖 StudioCMS 环境。 ## 包目录分类 ### StudioCMS ...

(AI_EN_LECTOR_MISSING_PUNCTUATION)

🪛 Gitleaks (8.26.0)
src/content/docs/zh-CN/start-here/getting-started.mdx

62-62: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

🔇 Additional comments (6)
src/content/docs/zh-CN/guides/upgrade/version-guides/0-1-0-beta-16.mdx (2)

42-45: Good use of locale-scoped reference link

The reference link keeps the /zh-CN/ prefix consistent with your folder rename, preventing the locale mismatch errors raised earlier. No action needed here. 👍


10-14: No casing mismatches between imports and file names
Both QuickUpdate.astro and ReadMore.astro under src/components match the import statements exactly. No further action is needed.

src/content/docs/zh-CN/guides/contributing/translations.mdx (2)

74-99: Validate <FileTree> child markup

The bullet list inside <FileTree> must follow the exact indentation expected by the component (2-space indents per level, no blank lines) or it will render as plain text instead of a tree.
Quickly preview locally to confirm nodes are rendered; if not, trim the blank line after <FileTree> and ensure each level is indented correctly.


1-7: Front-matter looks good but double-check ordering key

sidebar: order: 2 is valid YAML, yet elsewhere in the repo sidebar_position (or sidebar.order) is sometimes used. Make sure this key matches the theme’s schema to avoid the page disappearing from the nav.

src/content/docs/zh-CN/guides/database/sqld-server.mdx (2)

82-87: No fixed directory for JWT keys—the SQLD_AUTH_JWT_KEY_FILE env var controls the path

The libsql-server image does not enforce or pre-create a specific directory for JWT key material. You may mount your public key at any container path—as long as you set SQLD_AUTH_JWT_KEY_FILE to point there. For example, the following is equally valid:

environment:
  - SQLD_AUTH_JWT_KEY_FILE=/keys/libsql.pub    # 指定容器内公钥路径
volumes:
  - ./keys/libsql.pub:/keys/libsql.pub         # 将本地密钥挂载到 /keys

Mounting to /home/.ssh/libsql.pub will work just the same, provided you bind-mount your host file to that path. If you prefer clearer conventions, you can use /keys/ (or any other directory) instead.

No changes required to use /home/.ssh here.

Likely an incorrect or invalid review comment.


134-136: Anchor is valid – no changes required
The slug 首次设置或数据表结构更新时 is generated from the heading
### 首次设置(或数据表结构更新时) on line 269 of
src/content/docs/zh-CN/start-here/getting-started.mdx, so the link #首次设置或数据表结构更新时 resolves correctly. No update needed.

Likely an incorrect or invalid review comment.

Comment thread src/content/docs/zh-CN/guides/contributing/translations.mdx
Comment thread src/content/docs/zh-CN/package-catalog/community-plugins/web-vitals.mdx Outdated
Comment thread src/content/docs/zh-CN/plugins/extended.mdx
Comment thread src/content/docs/zh-CN/plugins/extended.mdx
@Adammatthiesen
Copy link
Copy Markdown
Member

please revert the folder name change. that broke things again... @jenxi

@jenxi
Copy link
Copy Markdown
Contributor Author

jenxi commented Jul 4, 2025

please revert the folder name change. that broke things again... @jenxi

It was working locally after the name change. The issue was with the sidebar translation setting.

@Adammatthiesen
Copy link
Copy Markdown
Member

Adammatthiesen commented Jul 4, 2025

2025-Jul-04 07:43:18.419732
#13 5.929 7:43:17 AM [vite] (ssr) Error when evaluating SSR module /app/astro.config.mts: Failed to load url /app/src/starlight-sidebar/zh-cn.json (resolved id: /app/src/starlight-sidebar/zh-cn.json). Does the file exist?
2025-Jul-04 07:43:18.419732
#13 5.929       at loadAndTransform (file:///app/node_modules/.pnpm/vite@6.3.0_@types+node@22.13.5_jiti@2.4.2_terser@5.39.0_yaml@2.7.0/node_modules/vite/dist/node/chunks/dep-BuM4AdeL.js:35659:17)
2025-Jul-04 07:43:18.419732
#13 5.932 [astro] Unable to load your Astro config
2025-Jul-04 07:43:18.419732
#13 5.932
2025-Jul-04 07:43:18.419732
#13 6.267 Failed to load url /app/src/starlight-sidebar/zh-cn.json (resolved id: /app/src/starlight-sidebar/zh-cn.json). Does the file exist?
2025-Jul-04 07:43:18.419732
#13 6.267   Stack trace:
2025-Jul-04 07:43:18.419732
#13 6.267     at loadAndTransform (file:///app/node_modules/.pnpm/vite@6.3.0_@types+node@22.13.5_jiti@2.4.2_terser@5.39.0_yaml@2.7.0/node_modules/vite/dist/node/chunks/dep-BuM4AdeL.js:35659:17)
2025-Jul-04 07:43:18.419732
#13 6.373  ELIFECYCLE  Command failed with exit code 1.
2025-Jul-04 07:43:18.419732
#13 6.410  ELIFECYCLE  Command failed with exit code 1.
2025-Jul-04 07:43:18.419732
#13 ERROR: process "/bin/bash -ol pipefail -c pnpm ci:build" did not complete successfully: exit code: 1

Deployments are still failing...

Lets keep it simple, and just keep the language lowercase all together... that would prevent the current issue of getting the URL correct across multiple files

@jenxi
Copy link
Copy Markdown
Contributor Author

jenxi commented Jul 4, 2025

The commit did not update the file name. I’ve manually updated it. Yeah, I made it all lowercase when I did the force push.

@Adammatthiesen
Copy link
Copy Markdown
Member

and we are back to needing these urls fixed:

11:05:41 ▶ zh-cn/start-here/getting-started/
11:05:41   ├─ /zh-cn/start-here/environment-variables/#http://localhost:4322/zh-cn/start-here/environment-variables/#studiocmsauth-加密密钥 - invalid hash
Error: 1 [ERROR] [starlight-links-validator-integration] An unhandled error occurred while running the "astro:build:done" hook
11:05:41   └─ /zh-cn/start-here/environment-variables/#http://localhost:4322/zh-cn/start-here/environment-variables/#oauth-认证环境变量 - invalid hash

Copy link
Copy Markdown
Contributor

@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: 1

♻️ Duplicate comments (1)
src/content/docs/zh-cn/start-here/getting-started.mdx (1)

195-198: Remove the stray back-tick that breaks Markdown rendering

The opening back-tick before “时需特别注意” starts an unintended code span and leaves it unclosed until the next back-tick, mangling the whole sentence.

-在配置 StudioCMS `时需特别注意:astro.config.mjs` 文件中的 ​`site` 配置项是必需参数,必须设置为您的站点实际 URL 或临时占位 URL 才能确保系统正常运行。(例如:`https://demo.studiocms.dev/` 或 `http://localhost:4321/`)
+在配置 StudioCMS 时需特别注意:`astro.config.mjs` 文件中的 `site` 配置项是必需参数,必须设置为您的站点实际 URL 或临时占位 URL 才能确保系统正常运行。(例如:`https://demo.studiocms.dev/` 或 `http://localhost:4321/`)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 905a534 and fcfa013.

📒 Files selected for processing (3)
  • src/content/docs/zh-cn/guides/index.mdx (1 hunks)
  • src/content/docs/zh-cn/start-here/environment-variables.mdx (1 hunks)
  • src/content/docs/zh-cn/start-here/getting-started.mdx (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • src/content/docs/zh-cn/guides/index.mdx
  • src/content/docs/zh-cn/start-here/environment-variables.mdx
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: ArmandPhilippot
PR: withstudiocms/docs#130
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-17.mdx:1-11
Timestamp: 2025-04-26T12:29:17.995Z
Learning: When reviewing translations in the withstudiocms/docs repository, compare with the corresponding English version as the source of truth, not with other files in the same target language. French translations should maintain structural parity with their English counterparts.
src/content/docs/zh-cn/start-here/getting-started.mdx (1)
Learnt from: ArmandPhilippot
PR: withstudiocms/docs#130
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-17.mdx:1-11
Timestamp: 2025-04-26T12:29:17.995Z
Learning: When reviewing translations in the withstudiocms/docs repository, compare with the corresponding English version as the source of truth, not with other files in the same target language. French translations should maintain structural parity with their English counterparts.
🪛 Gitleaks (8.26.0)
src/content/docs/zh-cn/start-here/getting-started.mdx

62-62: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

🔇 Additional comments (1)
src/content/docs/zh-cn/start-here/getting-started.mdx (1)

340-348: Double-check that the referenced anchors actually exist

The footer links point to Chinese anchor slugs such as
#astrojsdb-数据库连接参数 and #studiocmsauth-加密密钥.
If the target pages were generated with different slug rules (e.g., percent-encoding or simplified punctuation removal), these hashes will 404.

Please verify with a local astro check or link-validator run.

Comment thread src/content/docs/zh-cn/start-here/getting-started.mdx
@Adammatthiesen
Copy link
Copy Markdown
Member

One left @jenxi

Error: 4 [ERROR] ✗ Found 1 invalid link in 1 file.
09:04:44 ▶ zh-cn/start-here/getting-started/
Error: 4 [ERROR] [starlight-links-validator-integration] An unhandled error occurred while running the "astro:build:done" hook
09:04:44   └─ /zh-cn/start-here/environment-variables/#studiocmsauth-加密密钥 - invalid hash

@jenxi
Copy link
Copy Markdown
Contributor Author

jenxi commented Jul 7, 2025

I think we’re finally there. Thanks for the patience @Adammatthiesen

@Adammatthiesen Adammatthiesen self-requested a review July 7, 2025 10:51
Copy link
Copy Markdown
Member

@Adammatthiesen Adammatthiesen left a comment

Choose a reason for hiding this comment

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

From my side of things, it looks good. I'm leaving this to the other members of the team to finalize and merge.

Copy link
Copy Markdown
Member

@dreyfus92 dreyfus92 left a comment

Choose a reason for hiding this comment

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

LGTM, awesome work @jenxi and thank you for championing this 🤘🏻

@dreyfus92 dreyfus92 merged commit ce9cf39 into withstudiocms:main Jul 8, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants