docs: polish homepage command sections - #483
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
Deploying rstack-cli with
|
| Latest commit: |
5435c23
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://dc5fbccd.rstack-cli.pages.dev |
| Branch Preview URL: | https://docs-polish-command-sections.rstack-cli.pages.dev |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 16594ebb38
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5435c23ba2
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| "en": "Automatically generate llms.txt and Markdown files for AI agents to read", | ||
| "zh": "自动生成 llms.txt 与 Markdown 文件，供 AI Agent 读取" |
There was a problem hiding this comment.
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 👍 / 👎.
| "en": "Bring code checks into your Git workflow while keeping your existing lint-staged configuration and Husky workflow", | ||
| "zh": "将代码检查融入 Git 工作流，延续现有 lint-staged 配置与 Husky 工作流" |
There was a problem hiding this comment.
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 👍 / 👎.
1 participant
Motivation
Make command capabilities clearer on the homepage and reduce wrapping in longer English descriptions.
Changes
Refine the English and Chinese copy for testing, code checks, Git hooks, and documentation, highlighting performance, compatibility, and AI-friendly documentation output. Give descriptions more horizontal space by widening the left column, narrowing terminal examples, and reducing the gap between them.