Skip to content

docs: improve i18n docs#8608

Merged
caohuilin merged 3 commits into
mainfrom
docs/i18n
May 13, 2026
Merged

docs: improve i18n docs#8608
caohuilin merged 3 commits into
mainfrom
docs/i18n

Conversation

@zllkjc
Copy link
Copy Markdown
Member

@zllkjc zllkjc commented May 12, 2026

Summary

中文

  • 重构中文 i18n 文档导航:移除 basic 页面入口,调整概览页为“从哪里开始”表格,帮助用户按场景进入 quick-start、configuration、routing、resource-loading 等页面。
  • 精简并重写快速开始、配置说明、语言检测、路由集成、资源加载、API、高级用法等章节,突出 CLI 配置与 runtime 配置职责、backend 自动启用规则、SDK/链式后端、SSR 等关键流程。
  • 补充最佳实践内容,包括 namespace 组织、翻译键命名、复数、嵌套键、格式化插值、加载状态与类型安全等建议。
  • 同步更新 i18n 相关文档组件中的安装命令、初始化说明和示例代码,使示例与新的文档结构保持一致。

English

  • Refactors the Chinese i18n documentation navigation by removing the basic page entry and turning the overview into a scenario-based “where to start” table.
  • Rewrites and streamlines quick start, configuration, locale detection, routing, resource loading, API, and advanced usage docs, with clearer guidance for CLI/runtime config ownership, backend auto enablement, SDK/chained backend, and SSR flows.
  • Expands best practices for namespace organization, translation key naming, plurals, nested keys, formatted interpolation, loading states, and type safety.
  • Updates shared i18n doc components for install commands, initialization notes, and example code so they align with the revised documentation.

Related Links

Checklist

  • I have added changeset via pnpm run change.
  • I have updated the documentation.
  • I have added tests to cover my changes.

@netlify
Copy link
Copy Markdown

netlify Bot commented May 12, 2026

Deploy Preview for modernjs-byted ready!

Name Link
🔨 Latest commit ebdb3b5
🔍 Latest deploy log https://app.netlify.com/projects/modernjs-byted/deploys/6a03261e9162c20008532a53
😎 Deploy Preview https://deploy-preview-8608--modernjs-byted.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 97 (🟢 up 3 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 12, 2026

⚠️ No Changeset found

Latest commit: ebdb3b5

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 12, 2026

Rsdoctor Bundle Diff Analysis

📊 Quick Summary
Project Total Size Change
bundle-diff 504.3 KB 0

Generated by Rsdoctor GitHub Action

@caohuilin caohuilin merged commit b9f08a4 into main May 13, 2026
10 checks passed
@caohuilin caohuilin deleted the docs/i18n branch May 13, 2026 03:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants