Skip to content

docs: polish homepage command sections #483

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chenjiahan merged 4 commits into from
Sep 14, 2026
+39 −39
Merged

docs: polish homepage command sections #483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
16594eb
docs: polish homepage command sections
chenjiahan Sep 14, 2026
d4cf4f9
docs: update check example file count
chenjiahan Sep 14, 2026
71cf414
docs: refine production optimization highlight
chenjiahan Sep 14, 2026
5435c23
docs: adjust command section columns and spacing
chenjiahan Sep 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 34 additions & 34 deletions website/i18n.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@
"zh": "构建速度比 webpack 快 5–20 倍"
},
"appCommandProduction": {
"en": "Built-in production optimizations for leaner bundles",
"zh": "内置多项生产优化能力，生成精简的产物"
"en": "Optimize bundles for faster runtime performance",
"zh": "全方位优化产物，运行更快"
},
"appCommandConfig": {
"en": "A consistent bundling process for development and production",
Expand Down Expand Up @@ -84,68 +84,68 @@
"zh": "熟悉的 Jest API"
},
"testCommandPerformance": {
"en": "Rspack-powered tests, over 20% faster than Jest",
"zh": "由 Rspack 加速测试，比 Jest 快 20% 以上"
"en": "Tests accelerated by Rspack, 20%+ faster than Jest",
"zh": "由 Rspack 加速测试，比 Jest 快 20%+"
},
"checkCommandTitle": {
"en": "Consistent code. One command",
"zh": "一个命令，保持代码一致"
"en": "Consistent standards, faster checks",
"zh": "统一规范，更快检查"
},
"checkCommandDesc": {
"en": "Unify linting and formatting checks while keeping your Prettier options and plugins",
"zh": "统一运行代码检查与格式校验，兼容 Prettier 选项与插件，延续团队代码规范"
"en": "One command for linting, formatting checks, and type checking to keep team standards consistent",
"zh": "一个命令完成代码检查、格式校验和类型检查，保持团队规范一致"
Comment thread
chenjiahan marked this conversation as resolved.
},
"checkCommandTypes": {
"en": "Type-aware linting with optional TypeScript type checking",
"zh": "支持类型感知规则，按需启用 TypeScript 类型检查"
"checkCommandLint": {
"en": "Lint 20–40× faster than ESLint",
"zh": "代码检查速度比 ESLint 快 20–40 倍"
},
"checkCommandFormat": {
"en": "Parallel formatting and persistent caching for faster repeat runs",
"zh": "并行格式化与持久化缓存，加速重复检查"
"en": "Format 5–10× faster than Prettier",
"zh": "格式化速度比 Prettier 快 5–10 倍"
},
"checkCommandFix": {
"en": "Fix lint and formatting issues with --fix",
"zh": "通过 --fix 自动修复代码与格式问题"
"checkCommandCompatibility": {
"en": "Compatible with ESLint and Prettier configuration and plugins",
"zh": "兼容 ESLint 和 Prettier 的配置项与插件"
Comment thread
chenjiahan marked this conversation as resolved.
},
"hooksCommandTitle": {
"en": "Better code in every commit",
"zh": "让每次提交，都经过检查"
"en": "Checks in every commit",
"zh": "让检查融入每次提交"
},
"hooksCommandDesc": {
"en": "Bring checks into your commit workflow, reuse lint-staged task configuration, and migrate existing Husky hooks",
"zh": "将代码检查融入提交流程，兼容 lint-staged 任务配置，支持迁移现有 Husky hooks"
"en": "Bring code checks into your Git workflow while keeping your existing lint-staged configuration and Husky workflow",
"zh": "将代码检查融入 Git 工作流，延续现有 lint-staged 配置与 Husky 工作流"
Comment on lines +115 to +116

@chatgpt-codex-connector chatgpt-codex-connector Bot Sep 14, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Describe migrating the Husky workflow

For a repository currently managed by Husky, rs hooks cannot keep that setup active: the documented behavior in website/docs/en/guide/cli/hooks.mdx:53-55 is to skip installation when another hooks path exists, while --force switches core.hooksPath and makes the prior hooks inactive. The hook bodies and environment settings must be migrated to Rstack first, so restoring the previous “migrate existing Husky hooks” wording would avoid implying direct compatibility.

Useful? React with 👍 / 👎.

},
"hooksCommandSetup": {
"en": "Manage repository-wide Git hooks in one place",
"zh": "统一管理仓库级 Git hooks"
},
"hooksCommandStaged": {
"en": "Check and format staged files before each commit",
"zh": "仅检查和格式化暂存文件，聚焦本次提交"
"en": "Automatically check staged files",
"zh": "自动检查暂存区文件"
},
"hooksCommandTasks": {
"en": "Match files with glob patterns and run custom tasks",
"zh": "按文件模式匹配任务，灵活运行自定义命令"
"en": "Run custom commands to suit your workflow",
"zh": "灵活运行自定义命令"
},
"docCommandTitle": {
"en": "Great docs, built right in",
"zh": "让文档，融入开发流程"
"en": "Build AI-friendly docs sites",
"zh": "生成 AI 友好的文档站"
},
"docCommandDesc": {
"en": "Build documentation sites with Rspress and maintain docs alongside your code",
"zh": "使用 Rspress 构建文档站点，让项目文档与代码一同开发和维护"
"en": "Generate beautiful, AI-friendly static documentation sites with Rspress and maintain docs alongside your code",
"zh": "使用 Rspress 生成美观、AI 友好的静态文档站，让文档与代码一同维护"
},
"docCommandMarkdown": {
"en": "Write Markdown and embed React components with MDX",
"zh": "支持 Markdown 与 MDX，灵活嵌入 React 组件"
"en": "Write content with Markdown and MDX",
"zh": "使用 Markdown 和 MDX 编写内容"
},
"docCommandFeatures": {
"en": "Built-in search and multilingual documentation",
"zh": "内置全文搜索，支持多语言文档"
"en": "Full-text search and multilingual support out of the box",
"zh": "开箱即用的全文搜索与多语言支持"
},
"docCommandWorkflow": {
"en": "One CLI for development, production builds, and local previews",
"zh": "统一完成文档开发、生产构建与本地预览"
"en": "Automatically generate llms.txt and Markdown files for AI agents to read",
"zh": "自动生成 llms.txt 与 Markdown 文件，供 AI Agent 读取"
Comment on lines +147 to +148

@chatgpt-codex-connector chatgpt-codex-connector Bot Sep 14, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Mark AI output generation as opt-in

For documentation projects without llms: true, Rspress does not generate these AI-oriented files. Both create-rstack documentation templates omit that option (packages/create-rstack/template-doc/rstack.config.ts:5-8), while this website explicitly enables it in website/rstack.config.ts:31, so users following the advertised default rs doc workflow will not receive the promised output. Qualify this as an optional capability or enable it in the generated configuration.

Useful? React with 👍 / 👎.

},
"guide": {
"en": "Guide",
Expand Down
4 changes: 2 additions & 2 deletions website/theme/components/Commands.module.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@

.section {
display: grid;
grid-template-columns: minmax(0, 1fr) minmax(0, 1.1fr);
grid-template-columns: minmax(0, 1.1fr) minmax(0, 1fr);
align-items: center;
gap: clamp(2.5rem, 6vw, 5.5rem);
gap: clamp(2rem, 4vw, 3rem);
padding: 5.5rem 0;
border-top: 1px solid var(--command-border);
}
Expand Down
6 changes: 3 additions & 3 deletions website/theme/components/Commands.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,9 +230,9 @@ export function Commands() {
<h2 id="commands-check-title">{t('checkCommandTitle')}</h2>
<p className={styles.description}>{t('checkCommandDesc')}</p>
<ul className={styles.highlights}>
<li>{t('checkCommandTypes')}</li>
<li>{t('checkCommandLint')}</li>
<li>{t('checkCommandFormat')}</li>
<li>{t('checkCommandFix')}</li>
<li>{t('checkCommandCompatibility')}</li>
</ul>
</div>
<Terminal>
Expand All @@ -249,7 +249,7 @@ export function Commands() {
<LogLabel>success</LogLabel>
{' Format check passed in '}
{'25ms'}
<span className={styles.dim}> (7 files)</span>
<span className={styles.dim}> (99 files)</span>
</Terminal>
</section>

Expand Down