docs/refine-ai-docs-0803 - #465
Conversation
…fied canary questions - Convert relative documentation links to absolute URLs (e.g., /skill.md → https://docs.ckbccc.com/skill.md) - Simplify canary questions in verify-and-troubleshoot for better clarity - Restructure prompting best practices content - Update both English and Chinese versions - Add AI resources section to README
Fix missing double slashes in Agent Skills link (https:docs.ckbccc.com → https://docs.ckbccc.com)
✅ Deploy Preview for apiccc ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for liveccc ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for docsccc ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
|
Warning Review limit reached
Next review available in: 32 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
📝 WalkthroughSummary by CodeRabbit
WalkthroughThe PR adds Agent Skills installation guidance, converts AI Resources links to canonical absolute URLs, rewrites English and Chinese prompting guidance, and clarifies verification questions for transaction ordering and Node.js imports. ChangesAI Resources documentation
Estimated code review effort: 2 (Simple) | ~15 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
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 |
✅ Deploy Preview for appccc ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
packages/docs/content/docs/ai-resources/verify-and-troubleshoot.mdx (1)
1-1: 🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick winUpdate the UDT prompt to mirror the skill/API form.
Verify & Troubleshootand the UDT docs useudt.completeBy(tx, signer), but the UDT one-line fix sayscompleteBy(tx, signer). Useudt.completeBy(...)in bothprompting-best-practices.mdx#96andprompting-best-practices.zh.mdx#95so the copy-paste prompt does not encourage the wrong API form.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/docs/content/docs/ai-resources/verify-and-troubleshoot.mdx` at line 1, Update the UDT one-line fix examples in prompting-best-practices.mdx and prompting-best-practices.zh.mdx to call udt.completeBy(...) instead of completeBy(...), matching the API form used by Verify & Troubleshoot and the other UDT documentation.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@packages/docs/content/docs/ai-resources/prompting-best-practices.mdx`:
- Around line 102-107: Update the third bullet in the “Three closing habits”
section to avoid repeating “again” in “ask again or have it re-check,” while
preserving the instruction to verify the package choice rather than relying on
the earlier answer.
- Around line 39-41: Update the introductory paragraph in the
skill-native/web-chat guidance so its bold emphasis closes before the bullet
list begins, matching the structure of the Chinese version. Remove the emphasis
delimiter that currently spans into the second list item and preserve the list
text as normal Markdown.
In `@README.md`:
- Line 63: Update the AI Resources link in the README to use the locale-prefixed
URL https://docs.ckbccc.com/en/docs/ai-resources instead of the unprefixed path.
---
Outside diff comments:
In `@packages/docs/content/docs/ai-resources/verify-and-troubleshoot.mdx`:
- Line 1: Update the UDT one-line fix examples in prompting-best-practices.mdx
and prompting-best-practices.zh.mdx to call udt.completeBy(...) instead of
completeBy(...), matching the API form used by Verify & Troubleshoot and the
other UDT documentation.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 9fe91355-7782-463c-8029-fb66b9cc0fef
📒 Files selected for processing (9)
README.mdpackages/docs/content/docs/ai-resources/index.mdxpackages/docs/content/docs/ai-resources/index.zh.mdxpackages/docs/content/docs/ai-resources/prompting-best-practices.mdxpackages/docs/content/docs/ai-resources/prompting-best-practices.zh.mdxpackages/docs/content/docs/ai-resources/set-up-ai-tools.mdxpackages/docs/content/docs/ai-resources/set-up-ai-tools.zh.mdxpackages/docs/content/docs/ai-resources/verify-and-troubleshoot.mdxpackages/docs/content/docs/ai-resources/verify-and-troubleshoot.zh.mdx
- Add prefix to documentation URLs in README for proper routing - Fix code examples in prompting best practices (add prefix to ) - Minor copy edits for clarity and consistency - Sync Chinese translation with English version
2 participants
Summary
Refines the AI-resources documentation (
packages/docs/content/docs/ai-resources/) for clarity and correctness, and surfaces this content from the README. Changes are applied to both English and Chinese versions.Changes
/skill.md→https://docs.ckbccc.com/skill.md) inset-up-ai-tools. This is a pilot on a single file — the goal is to make links resolve correctly when this content is consumed outside the rendered site (e.g. fetched as raw Markdown by an AI tool, or copied into another tool's config/rules file), where relative paths have no meaningful base. A full pass across the remaining docs will follow once this is validated in practice.verify-and-troubleshootfor better clarity.prompting-best-practicescontent.enandzhversions.Why
The AI-resources docs are meant to be read by AI tools and agents as much as by humans (via
/skill.md,.mdpage exports,llms.txt, etc.), so link portability outside the rendered site matters more here than in typical docs pages. The canary-question and prompting-best-practices edits are clarity/readability improvements based on review of the existing content.Notes for reviewers
set-up-ai-toolsonly for this PR. Other pages (e.g. thellms.txtreference row in this same file, and any similar self-links elsewhere) still use relative paths and are left untouched pending a broader, consistent pass in a follow-up PR.packages/docscontent and the rootREADME.md.Testing
.mdexport of the updated page resolves links correctly outside the rendered site.