Repository navigation
docs: expand compilation database generation guide - #401
Merged
Merged
Conversation
Co-Authored-By: Stehsaer <Stehsaer@users.noreply.github.com> Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
📝 WalkthroughWalkthroughUpdated English and Chinese Quick Start guides with concrete, build-system-specific instructions to generate Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (2)
docs/en/guide/quick-start.md (1)
79-83: Clarify thesettings.jsonsnippet for copy-paste safety.Consider showing the key inside a minimal JSON object (or explicitly noting trailing comma rules) so users don’t paste an invalid fragment; also “updates on
xmake.lua” reads better as “updates toxmake.lua.”✏️ Proposed doc tweak
-The Xmake official VSCode extension provides autonomous generation of compilation database upon updates on `xmake.lua`. However, it generates the database to `.vscode` directory. Append this setting in `settings.json`: +The official Xmake VS Code extension can auto-generate the compilation database when `xmake.lua` is updated. By default, it writes to the `.vscode` directory. Add this in `settings.json`: ```json -"xmake.compileCommandsDirectory": "build" +{ + "xmake.compileCommandsDirectory": "build" +}</details> </blockquote></details> <details> <summary>docs/zh/guide/quick-start.md (1)</summary><blockquote> `77-85`: **优化中文技术文档可读性（术语与路径前后空格）。** 这里建议对 `VSCode`、`.vscode`、`settings.json`、`build` 等术语前后加空格，并稍微收敛句式，阅读体验会更好。 <details> <summary>✏️ 建议改写</summary> ```diff -#### VSCode扩展 +#### VS Code 扩展 -Xmake提供的官方VSCode扩展已经自带了编译数据库生成（保存时其会自动生成编译数据库）。然而默认情况下，它将编译数据库生成到了`.vscode`文件夹。在`settings.json`中添加以下配置： +Xmake 官方 VS Code 扩展自带编译数据库生成能力（保存时会自动生成）。但默认会生成到 `.vscode` 目录。可在 `settings.json` 中添加： @@ -以将编译数据库的生成目录调整到`build`，供clice使用。 +将编译数据库输出目录调整到 `build`，供 clice 使用。🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/zh/guide/quick-start.md` around lines 77 - 85, Edit the paragraph about the VSCode extension to improve Chinese readability by adding spaces around technical terms and paths (e.g., "VSCode", ".vscode", "settings.json", "build") and tightening the sentence structure; specifically, rewrite the two sentences so they read smoothly and concisely (mention that Xmake 的 VSCode 扩展会在保存时自动生成编译数据库，默认放在 `.vscode`，并示例在 `settings.json` 中添加 `"xmake.compileCommandsDirectory": "build"` 来改为 `build` 目录供 clice 使用), ensuring each term has a space before and after for clarity.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/zh/guide/quick-start.md`:
- Around line 77-85: Edit the paragraph about the VSCode extension to improve
Chinese readability by adding spaces around technical terms and paths (e.g.,
"VSCode", ".vscode", "settings.json", "build") and tightening the sentence
structure; specifically, rewrite the two sentences so they read smoothly and
concisely (mention that Xmake 的 VSCode 扩展会在保存时自动生成编译数据库，默认放在 `.vscode`，并示例在
`settings.json` 中添加 `"xmake.compileCommandsDirectory": "build"` 来改为 `build` 目录供
clice 使用), ensuring each term has a space before and after for clarity.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 42609713-d53b-4d66-8d38-4ce5829da4e4
📒 Files selected for processing (2)
docs/en/guide/quick-start.mddocs/zh/guide/quick-start.md
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
… catter Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/zh/guide/quick-start.md`:
- Line 82: The Chinese phrasing in the sentence "注意 `bear`
需要干净的构建来捕获所有命令——如果需要的话，在运行 `bear -- make` 之前先执行 `make clean`。" is unnatural;
replace "需要干净的构建" with "需要干净地构建" so the sentence reads "注意 `bear`
需要干净地构建来捕获所有命令——如果需要的话，在运行 `bear -- make` 之前先执行 `make clean`。", updating the
existing sentence text accordingly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 39bdc457-9921-4dbe-965f-48894259e943
📒 Files selected for processing (2)
docs/en/guide/quick-start.mddocs/zh/guide/quick-start.md
✅ Files skipped from review due to trivial changes (1)
- docs/en/guide/quick-start.md
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/zh/guide/quick-start.md (1)
82-82:⚠️ Potential issue | 🟡 Minor中文措辞建议沿用先前修正：将“干净的构建”改为“干净地构建”。
Line 82 当前表述仍略不自然，建议改为“
bear需要干净地构建来捕获所有命令”。✏️ 建议修改
-这会在当前目录生成 `compile_commands.json`。注意 `bear` 需要干净的构建来捕获所有命令——如果需要的话，在运行 `bear -- make` 之前先执行 `make clean`。 +这会在当前目录生成 `compile_commands.json`。注意 `bear` 需要干净地构建来捕获所有命令——如果需要的话，在运行 `bear -- make` 之前先执行 `make clean`。🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/zh/guide/quick-start.md` at line 82, Update the Chinese wording in the sentence containing `bear` and `bear -- make`: replace “干净的构建” with “干净地构建” so the sentence reads like “`bear` 需要干净地构建来捕获所有命令——如果需要的话，在运行 `bear -- make` 之前先执行 `make clean`。”; adjust only that phrase in quick-start.md to keep wording consistent with prior fixes.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/zh/guide/quick-start.md`:
- Line 82: Update the Chinese wording in the sentence containing `bear` and
`bear -- make`: replace “干净的构建” with “干净地构建” so the sentence reads like “`bear`
需要干净地构建来捕获所有命令——如果需要的话，在运行 `bear -- make` 之前先执行 `make clean`。”; adjust only that
phrase in quick-start.md to keep wording consistent with prior fixes.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: d226afff-3a3c-4223-a339-831e6ce29c35
📒 Files selected for processing (2)
docs/en/guide/quick-start.mddocs/zh/guide/quick-start.md
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/en/guide/quick-start.md
16bit-ykiko
changed the title
Merged
4 tasks done
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Supersedes #313 by @Stehsaer.
🤖 Generated with Claude Code