chore: update README #923
chore: update README #923
Conversation
Removed unnecessary line break from README.
|
📝 WalkthroughWalkthroughREADME and localized README files were reorganized and reworded: header images resized/replaced, centered H3 titles added, navigation condensed, content restructured into anchored sections (Core TypeScript Framework, VoltOps Console, examples, guardrails, evals, RAG, etc.), many images swapped for thumbnails, and examples/quick-start content updated. Changes
Sequence Diagram(s)(omitted — changes are documentation/content reorganizations without new multi-component control flow) Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 📜 Recent review detailsConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used🧠 Learnings (1)📚 Learning: 2026-01-07T05:09:23.217ZApplied to files:
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (7)
🔇 Additional comments (1)
Comment |
This comment has been minimized.
This comment has been minimized.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
284-284: Fix image alt text typo on line 284.The alt text reads
"dashboar"instead of"dashboard". Correct alt text improves accessibility and user experience.📝 Proposed fix
-<img alt="dashboar" src="https://github.com/user-attachments/assets/c88a5543-219e-4cf0-8f41-14a68ca297fb" /> +<img alt="dashboard" src="https://github.com/user-attachments/assets/c88a5543-219e-4cf0-8f41-14a68ca297fb" />
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2026-01-07T05:09:23.217Z
Learnt from: CR
Repo: VoltAgent/voltagent PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-07T05:09:23.217Z
Learning: Use the established registry patterns for agent and tool management in VoltAgent
Applied to files:
README.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
- GitHub Check: Test core
- GitHub Check: Test cli
- GitHub Check: Build (Node 24)
- GitHub Check: Build (Node 22)
- GitHub Check: Build (Node 20)
- GitHub Check: Cloudflare Pages
🔇 Additional comments (5)
README.md (5)
3-3: Verify the header image URL is permanent and doesn't require authentication.The image source uses a GitHub user-attachments URL, which may be temporary or inaccessible in some contexts. Consider hosting critical README assets on a permanent CDN or within the repository (e.g., in a
/docs/assets/directory) to ensure long-term stability and availability.
264-347: VoltOps Console section is well-structured, with clear subsections and anchor support.The reorganization into categorized subsections (Observability, Dashboard, Logs, Memory Management, etc.) significantly improves navigation and user experience. The addition of anchor ID (
id="voltops-console") enables direct linking.
64-66: New feature additions (Voice, Guardrails, Evals) are well-integrated.The three new features are appropriately documented with clear descriptions and links to respective documentation pages. They fit naturally within the Core Framework feature list and align with the platform's expanded capabilities.
45-50: Improved intro messaging with clear value proposition.The restructured intro paragraph now clearly establishes VoltAgent as an "end-to-end AI Agent Engineering Platform" and immediately highlights the two main components (Open-Source TypeScript Framework and VoltOps Console) with anchor links. This improves discoverability and navigation.
56-72: All documentation links in the Core Framework section (lines 56-72) are accessible and return HTTP 200 status codes. No action required.Likely an incorrect or invalid review comment.
Deploying voltagent with
|
| Latest commit: |
a549766
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f3b9f75a.voltagent.pages.dev |
| Branch Preview URL: | https://update-readme-2.voltagent.pages.dev |
There was a problem hiding this comment.
Actionable comments posted: 5
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
README.md (2)
282-282: Typo in image alt text (appears across all three README versions).Line 282 has an alt text of
"dashboar"which should be"dashboard". This same typo appears in all three README files (English, Traditional Chinese, and Korean versions).🔧 Suggested fix
-<img alt="dashboar" src="https://github.com/user-attachments/assets/c88a5543-219e-4cf0-8f41-14a68ca297fb" /> +<img alt="dashboard" src="https://github.com/user-attachments/assets/c88a5543-219e-4cf0-8f41-14a68ca297fb" />Apply this fix to all three README files.
152-152: Replacethumbnail.pngplaceholder with actual GitHub asset URLs.Lines 152 and 233 reference
thumbnail.png, which does not exist. This placeholder appears across all three README versions (English, Traditional Chinese, Korean) at identical line numbers, indicating a systematic issue from initial implementation.🔧 Suggested fix
Replace the placeholder
thumbnail.pngwith the actual GitHub asset URL already present in the link target:-[](https://github.com/user-attachments/assets/26340c6a-be34-48a5-9006-e822bf6098a7) +[](https://github.com/user-attachments/assets/26340c6a-be34-48a5-9006-e822bf6098a7)-[](https://github.com/user-attachments/assets/3d3ea67b-4ab5-4dc0-932d-cedd92894b18) +[](https://github.com/user-attachments/assets/3d3ea67b-4ab5-4dc0-932d-cedd92894b18)Apply to all three README files: README.md, i18n/README-cn-traditional.md, and i18n/README-kr.md.
🤖 Fix all issues with AI agents
In @i18n/README-cn-bsc.md:
- Line 107: The README code example contains an English value for the YAML key
instructions ("A helpful assistant that can check weather and help with various
tasks"); replace that string with a Chinese translation such as
"一个可以查看天气并帮助完成各种任务的有用助手", preserving quotes and YAML formatting so the key
instructions retains a string value.
In @i18n/README-cn-traditional.md:
- Line 152: Replace the broken local image reference "thumbnail.png" in
README-cn-traditional.md with the actual GitHub asset URL(s): locate both
occurrences of "thumbnail.png" (around the two image markdown lines) and update
each markdown image link to point to the corresponding raw GitHub asset URL for
the image (ensure you paste the full https://...githubusercontent.com/... asset
link), then save and verify the image renders correctly in the rendered Markdown
preview.
In @i18n/README-jp.md:
- Line 282: Fix the typo in the img element’s alt attribute by changing
alt="dashboar" to alt="dashboard" in the <img> tag so the accessible/visible alt
text is correct.
In @i18n/README-kr.md:
- Line 282: Fix the typo in the image alt attribute by updating the <img> tag
whose alt is "dashboar" to use the correct text "dashboard" (locate the <img
alt="dashboar" ... /> instance and change the alt value to "dashboard").
- Line 152: The README-kr.md contains broken Markdown image references using
"thumbnail.png" (e.g., the line with "[](https://github.com/user-attachments/...)" at the demo
links); replace each "thumbnail.png" occurrence with the correct GitHub asset
URL(s) for the demo thumbnails so the images render (update both occurrences
referenced around lines 152 and 233), ensuring the Markdown link syntax remains
the same and the image URLs point to the actual asset locations.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
README.mdi18n/README-cn-bsc.mdi18n/README-cn-traditional.mdi18n/README-jp.mdi18n/README-kr.md
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2026-01-07T05:09:23.217Z
Learnt from: CR
Repo: VoltAgent/voltagent PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-07T05:09:23.217Z
Learning: Use the established registry patterns for agent and tool management in VoltAgent
Applied to files:
i18n/README-kr.mdi18n/README-jp.mdi18n/README-cn-bsc.mdREADME.md
🪛 LanguageTool
i18n/README-cn-traditional.md
[uncategorized] ~286-~286: 您的意思是“"不"驟”？
Context: ...-14a68ca297fb" /> ### 日誌 追蹤每個代理互動和工作流程步驟的詳細執行日誌。 
[uncategorized] ~310-~310: 数词与名词之间一般应存在量词，可能缺少量词。
Context: ...1-4443-a494-08c33ec9bcc4" /> ### 部署 透過一鍵 GitHub 整合和託管基礎設施將您的代理部署到生產環境。 <img alt...
(wa5)
i18n/README-kr.md
[grammar] ~43-~43: Typographie
Context: ...t는 두 가지 주요 부분으로 구성된 엔드투엔드 AI 에이전트 엔지니어링 플랫폼입니다: - **오픈소스 TypeScript 프레임워크*...
(QB_NEW_FR_OTHER_ERROR_IDS_MISSING_ORTHOGRAPHY_SPACE)
[grammar] ~51-~51: Typographie
Context: ...re-framework">코어 TypeScript 프레임워크 오픈소스 프레임워크를 사용하면 모든 AI 제공자에 연결하면서 메모리, 도구, 다...
(QB_NEW_FR_OTHER_ERROR_IDS_MISSING_ORTHOGRAPHY_SPACE)
[grammar] ~52-~52: Essayez « 멀티에이gent »
Context: ... 있습니다. 전문화된 에이전트가 감독자 조정 하에 함께 작동하는 정교한 멀티 에이전트 시스템을 만드세요. - **[코어 런타임](https://voltag...
(QB_NEW_FR_OTHER_ERROR_IDS_REPLACEMENT_NOUN_멀티_에이전트_멀티에이GENT)
[typographical] ~62-~62: Pas de correspondance fermante ou ouvrante pour le caractère « [ »
Context: ...임베딩, 검색을 위한 매니지드 RAG 서비스를 사용하세요. - **[음성](https://voltagent.dev/docs/agents/voice...
(UNPAIRED_BRACKETS)
[grammar] ~253-~253: Envisagez un remplacement
Context: ...t.dev/examples/guides/airtable-agent)** - 새 레코드에 반응하고 VoltOps 액션으로 Airtable에 업데이트를 ...
(QB_NEW_FR_OTHER_ERROR_IDS_REPLACEMENT_PUNCTUATION_DASH_–)
[grammar] ~254-~254: Envisagez un remplacement
Context: ...로 Airtable에 업데이트를 작성합니다. - Slack 에이전트 - 채널 메시지에 응답하고 VoltOps Slack 액션으로 답장합니다. - *...
(QB_NEW_FR_OTHER_ERROR_IDS_REPLACEMENT_PUNCTUATION_DASH_–)
[grammar] ~255-~255: Envisagez un remplacement
Context: ...ck 액션으로 답장합니다. - ChatGPT 앱과 VoltAgent - VoltAgent를 MCP를 통해 배포하고 ChatGPT 앱에 연결합니다. - **[Wha...
(QB_NEW_FR_OTHER_ERROR_IDS_REPLACEMENT_PUNCTUATION_DASH_–)
[grammar] ~256-~256: Envisagez un remplacement
Context: ...ev/examples/agents/whatsapp-ai-agent)** - 자연스러운 대화로 음식 주문을 처리하는 WhatsApp 챗봇을 구축합니다. ([소...
(QB_NEW_FR_OTHER_ERROR_IDS_REPLACEMENT_PUNCTUATION_DASH_–)
[grammar] ~256-~256: Il y a peut-être une erreur ici
Context: ...tagent/tree/main/examples/with-whatsapp)) - **[YouTube to 블로그 에이전트](https://voltagent.d...
(QB_NEW_FR)
[grammar] ~257-~257: Envisagez un remplacement
Context: ...with-whatsapp)) - YouTube to 블로그 에이전트 - MCP 도구를 사용한 감독자 에이전트로 YouTube 비디오를 Markdown...
(QB_NEW_FR_OTHER_ERROR_IDS_REPLACEMENT_PUNCTUATION_DASH_–)
[grammar] ~258-~258: Envisagez un remplacement
Context: ...xamples/agents/ai-instagram-ad-agent)** - BrowserBase Stagehand와 Google Gemini AI를 사용하여 Insta...
(QB_NEW_FR_OTHER_ERROR_IDS_REPLACEMENT_PUNCTUATION_DASH_–)
[grammar] ~259-~259: Envisagez un remplacement
Context: ...dev/examples/agents/recipe-generator)** - 재료와 선호도에 따라 개인화된 요리 제안을 만듭니다. ([소스 코드](http...
(QB_NEW_FR_OTHER_ERROR_IDS_REPLACEMENT_PUNCTUATION_DASH_–)
[grammar] ~259-~259: Il y a peut-être une erreur ici
Context: ...r) | 비디오) - **[AI 연구 어시스턴트 에이전트](https://voltagent.dev/...
(QB_NEW_FR)
[grammar] ~260-~260: Envisagez un remplacement
Context: ...v/examples/agents/research-assistant)** - 포괄적인 보고서를 생성하는 멀티 에이전트 연구 워크플로. ([소스 코드](htt...
(QB_NEW_FR_OTHER_ERROR_IDS_REPLACEMENT_PUNCTUATION_DASH_–)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
- GitHub Check: cubic · AI code reviewer
- GitHub Check: Test cli
- GitHub Check: Build (Node 20)
- GitHub Check: Build (Node 22)
- GitHub Check: Build (Node 24)
- GitHub Check: Cloudflare Pages
🔇 Additional comments (2)
README.md (1)
1-367: Verify consistency across all language versions.The three README files (English, Traditional Chinese, Korean) show identical structural changes and the same image reference bugs at identical line numbers. Verify that:
- All anchor IDs (
#core-framework,#voltops-console, etc.) are properly implemented in all versions- All external documentation links (e.g., Voice, Guardrails, Evals docs) are valid and point to the correct URLs
- Language-specific content (translations) accurately reflect the English version's meaning
Since this is a documentation-focused PR with no associated issue number, ensure test coverage exists for links in CI/CD (e.g., link checker tool).
i18n/README-cn-bsc.md (1)
152-152: Clarify placeholder image references.Lines 152 and 233 reference
thumbnail.pngas an image source, while other images in the file use full GitHub asset URLs (e.g., line 276). These appear to be placeholders. If intentional, confirm this matches the intended behavior; otherwise, update them to point to valid asset URLs like the surrounding examples.Also applies to: 233-233
| const agent = new Agent({ | ||
| name: "my-agent", | ||
| instructions: "可以检查天气并协助各种任务的有用助手", | ||
| instructions: "A helpful assistant that can check weather and help with various tasks", |
There was a problem hiding this comment.
Untranslated English text in Chinese README.
Line 107 contains an English instruction string within a code example in a Chinese README, breaking localization consistency. This string should be translated to Chinese to maintain a cohesive reader experience.
🔤 Proposed fix to translate the instruction string
const agent = new Agent({
name: "my-agent",
- instructions: "A helpful assistant that can check weather and help with various tasks",
+ instructions: "一个可以检查天气和帮助处理各种任务的有用助手",
model: openai("gpt-4o-mini"),Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In @i18n/README-cn-bsc.md at line 107, The README code example contains an
English value for the YAML key instructions ("A helpful assistant that can check
weather and help with various tasks"); replace that string with a Chinese
translation such as "一个可以查看天气并帮助完成各种任务的有用助手", preserving quotes and YAML
formatting so the key instructions retains a string value.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
7 issues found across 5 files (changes from recent commits).
Prompt for AI agents (all issues)
Check if these issues are valid — if so, understand the root cause of each and fix them.
<file name="i18n/README-cn-traditional.md">
<violation number="1" location="i18n/README-cn-traditional.md:152">
P2: Broken image reference: `thumbnail.png` does not exist in the repository. The image will not render. Consider using a full URL to a hosted image asset (like the previous `https://github.com/user-attachments/assets/...` format) or ensure the thumbnail file exists.</violation>
<violation number="2" location="i18n/README-cn-traditional.md:233">
P2: Broken image reference: `thumbnail.png` does not exist. This will display a broken image. Consider using a direct URL to the asset.</violation>
</file>
<file name="i18n/README-jp.md">
<violation number="1" location="i18n/README-jp.md:152">
P2: Broken image reference: `thumbnail.png` does not exist in the repository. This will display a broken image icon. Consider either adding the thumbnail file or using the GitHub video asset URL directly as the image source.</violation>
</file>
<file name="i18n/README-kr.md">
<violation number="1" location="i18n/README-kr.md:152">
P2: Broken image reference: `thumbnail.png` does not exist in the repository. The previous version used a working GitHub URL. Consider either adding the `thumbnail.png` file or using the full GitHub asset URL as the image source.</violation>
<violation number="2" location="i18n/README-kr.md:233">
P2: Broken image reference: `thumbnail.png` does not exist in the repository. The previous version used a working GitHub URL. Consider either adding the `thumbnail.png` file or using the full GitHub asset URL as the image source.</violation>
</file>
<file name="i18n/README-cn-bsc.md">
<violation number="1" location="i18n/README-cn-bsc.md:152">
P2: The file `thumbnail.png` does not exist in the repository. This relative path reference will result in a broken image thumbnail. Consider using a full URL to an existing image asset or adding the thumbnail.png file to the repository.</violation>
<violation number="2" location="i18n/README-cn-bsc.md:233">
P2: The file `thumbnail.png` does not exist in the repository. This relative path reference will result in a broken image thumbnail. Consider using a full URL to an existing image asset.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
packages/core/README.md (1)
345-345: Remove TODO placeholder before merging.Line 345 contains a placeholder comment
(link needed if available)that should not ship in production documentation. Either add a valid contribution guidelines link or remove the parenthetical remark.Proposed fix
-We welcome contributions! Please refer to the contribution guidelines (link needed if available). Join our [Discord](https://s.voltagent.dev/discord) server for questions and discussions. +We welcome contributions! Please join our [Discord](https://s.voltagent.dev/discord) server for questions and discussions.Or, if contribution guidelines exist, link them:
-We welcome contributions! Please refer to the contribution guidelines (link needed if available). Join our [Discord](https://s.voltagent.dev/discord) server for questions and discussions. +We welcome contributions! Please refer to the [contribution guidelines](CONTRIBUTING.md). Join our [Discord](https://s.voltagent.dev/discord) server for questions and discussions.
🤖 Fix all issues with AI agents
In @packages/core/README.md:
- Line 142: Replace the broken local image references "[](https://...)" found in the README occurrences (the two
markdown image links that use "thumbnail.png") with valid GitHub asset URLs or
remove the image link entirely; locate the two instances of the exact markdown
pattern using "thumbnail.png" and update each to point to the corresponding
remote asset URL (matching the format used elsewhere in the README) or delete
the image markup so the link targets remain functional.
🧹 Nitpick comments (2)
packages/core/README.md (2)
243-243: Simplify phrase for clarity.Line 243 uses "React to new records," which could be more concise. Consider rewording to reduce verbosity without losing meaning.
Suggested revision
-- **[Airtable Agent](https://voltagent.dev/examples/guides/airtable-agent)** - React to new records and write updates back into Airtable with VoltOps actions. +- **[Airtable Agent](https://voltagent.dev/examples/guides/airtable-agent)** - Monitor Airtable records and write updates back with VoltOps actions.
278-278: Consider consolidating image hosting approach.The README mixes three image hosting patterns: GitHub asset URLs (lines 3, 266, 296, 310, 317, 323, 329, 334), local file references (lines 142, 223 – broken), and CDN URLs (lines 278, 284, 290). For consistency and reliability, prefer GitHub asset URLs for all VoltOps Console screenshots, as they're already used extensively elsewhere in the file.
Migrating the CDN URLs (cdn.voltagent.dev/console/*) to GitHub asset URLs would improve consistency and ensure the file remains maintainable if the CDN structure changes.
Also applies to: 284-284, 290-290
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
packages/core/README.md
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2026-01-07T05:09:23.217Z
Learnt from: CR
Repo: VoltAgent/voltagent PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-07T05:09:23.217Z
Learning: Use the established registry patterns for agent and tool management in VoltAgent
Applied to files:
packages/core/README.md
🪛 LanguageTool
packages/core/README.md
[style] ~243-~243: ‘new records’ might be wordy. Consider a shorter alternative.
Context: ...les/guides/airtable-agent)** - React to new records and write updates back into Airtable wi...
(EN_WORDINESS_PREMIUM_NEW_RECORDS)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
- GitHub Check: cubic · AI code reviewer
- GitHub Check: Test core
- GitHub Check: Build (Node 20)
- GitHub Check: Build (Node 22)
- GitHub Check: Build (Node 24)
- GitHub Check: Cloudflare Pages
🔇 Additional comments (1)
packages/core/README.md (1)
33-39: Anchor links and formatting are correctly configured.All anchor references resolve correctly:
#core-framework(line 35) matches theid="core-framework"at line 40#voltops-console(line 36) matches theid="voltops-console"at line 252No changes needed.
There was a problem hiding this comment.
3 issues found across 1 file (changes from recent commits).
Prompt for AI agents (all issues)
Check if these issues are valid — if so, understand the root cause of each and fix them.
<file name="packages/core/README.md">
<violation number="1" location="packages/core/README.md:142">
P2: Missing image file `thumbnail.png`. This relative path references a file that doesn't exist in `packages/core/`, resulting in a broken image. Consider using the full GitHub asset URL directly or adding the thumbnail file.</violation>
<violation number="2" location="packages/core/README.md:223">
P2: The image reference `thumbnail.png` will fail to render because this file does not exist in the repository. Use the actual GitHub asset URL for the image source instead.</violation>
<violation number="3" location="packages/core/README.md:272">
P3: Typo in alt text: `dashboar` should be `dashboard`.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In @packages/core/README.md:
- Line 142: The README contains a broken markdown image reference "[](...)" that points to a non-existent relative file; fix by
replacing "thumbnail.png" with a valid image URL or a correct
repository-relative path to an existing asset (or remove the image if none
exists), ensuring the alt text and link remain intact; update the markdown line
so the image resolves (e.g., use a hosted URL or move the actual thumbnail into
the repo and reference its correct path) and commit the change.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
packages/core/README.md
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2026-01-07T05:09:23.217Z
Learnt from: CR
Repo: VoltAgent/voltagent PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-07T05:09:23.217Z
Learning: Use the established registry patterns for agent and tool management in VoltAgent
Applied to files:
packages/core/README.md
🪛 LanguageTool
packages/core/README.md
[style] ~243-~243: ‘new records’ might be wordy. Consider a shorter alternative.
Context: ...les/guides/airtable-agent)** - React to new records and write updates back into Airtable wi...
(EN_WORDINESS_PREMIUM_NEW_RECORDS)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Build (Node 24)
- GitHub Check: Build (Node 20)
- GitHub Check: Build (Node 22)
- GitHub Check: Cloudflare Pages
🔇 Additional comments (1)
packages/core/README.md (1)
1-357: Good restructuring overall; content reorganization is clear and comprehensive.The README now has a well-framed two-part structure (Core TypeScript Framework vs. VoltOps Console), improved navigation with anchor links, expanded Quick Start with code examples, and a detailed workflow walkthrough. The badge updates and asset references (aside from line 142) appear properly aligned with the new layout.
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
i18n/README-cn-traditional.md (1)
105-111: Localization inconsistency: Code example instructions should be in Traditional Chinese.Line 107 contains English text in a Traditional Chinese README:
"A helpful assistant that can check weather and help with various tasks". The previous version had this in Chinese:"可以檢查天氣並協助各種任務的有用助手".For consistency and readability of the localized documentation, code examples should use the document's primary language. Reverting to Chinese will help Traditional Chinese readers better understand the example.
🔧 Suggested fix to restore Chinese instructions
const agent = new Agent({ name: "my-agent", - instructions: "A helpful assistant that can check weather and help with various tasks", + instructions: "可以檢查天氣並協助各種任務的有用助手", model: openai("gpt-4o-mini"), tools: [weatherTool], memory, });
🤖 Fix all issues with AI agents
In @i18n/README-jp.md:
- Line 282: Update the img tag's alt attribute to correct the typo: change
alt="dashboar" to alt="dashboard" in the <img> element shown; ensure the
corrected alt text is used in the same tag so accessibility and copy/readers
reflect "dashboard" accurately.
In @i18n/README-kr.md:
- Line 282: Update the image tag's alt attribute that currently reads
`alt="dashboar"` to the correct spelling `alt="dashboard"`; locate the <img ...
alt="dashboar" ... /> snippet in the README-kr.md content and change the alt
text only (preserving the src and other attributes).
🧹 Nitpick comments (1)
i18n/README-cn-bsc.md (1)
105-111: Translate English instruction string for complete localization.The
instructionsfield at line 107 contains an English string in an otherwise fully-localized code example. To provide a complete experience for Chinese readers, this user-facing instruction should be translated to Chinese, even though code identifiers and imports remain in English (which is conventional).🌐 Proposed translation fix
const agent = new Agent({ name: "my-agent", - instructions: "A helpful assistant that can check weather and help with various tasks", + instructions: "一个可以检查天气和帮助处理各种任务的有用助手", model: openai("gpt-4o-mini"),
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
i18n/README-cn-bsc.mdi18n/README-cn-traditional.mdi18n/README-jp.mdi18n/README-kr.mdpackages/core/README.md
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2026-01-07T05:09:23.217Z
Learnt from: CR
Repo: VoltAgent/voltagent PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-07T05:09:23.217Z
Learning: Use the established registry patterns for agent and tool management in VoltAgent
Applied to files:
i18n/README-kr.mdpackages/core/README.mdi18n/README-cn-bsc.mdi18n/README-jp.md
🪛 LanguageTool
i18n/README-kr.md
[grammar] ~43-~43: Typographie
Context: ...t는 두 가지 주요 부분으로 구성된 엔드투엔드 AI 에이전트 엔지니어링 플랫폼입니다: - **오픈소스 TypeScript 프레임워크*...
(QB_NEW_FR_OTHER_ERROR_IDS_MISSING_ORTHOGRAPHY_SPACE)
[grammar] ~51-~51: Typographie
Context: ...re-framework">코어 TypeScript 프레임워크 오픈소스 프레임워크를 사용하면 모든 AI 제공자에 연결하면서 메모리, 도구, 다...
(QB_NEW_FR_OTHER_ERROR_IDS_MISSING_ORTHOGRAPHY_SPACE)
[grammar] ~52-~52: Essayez « 멀티에이gent »
Context: ... 있습니다. 전문화된 에이전트가 감독자 조정 하에 함께 작동하는 정교한 멀티 에이전트 시스템을 만드세요. - **[코어 런타임](https://voltag...
(QB_NEW_FR_OTHER_ERROR_IDS_REPLACEMENT_NOUN_멀티_에이전트_멀티에이GENT)
[typographical] ~62-~62: Pas de correspondance fermante ou ouvrante pour le caractère « [ »
Context: ...임베딩, 검색을 위한 매니지드 RAG 서비스를 사용하세요. - **[음성](https://voltagent.dev/docs/agents/voice...
(UNPAIRED_BRACKETS)
[grammar] ~253-~253: Envisagez un remplacement
Context: ...in/examples)를 방문하세요. - Airtable 에이전트 - 새 레코드에 반응하고 VoltOps 액션으로 Airtable에 업데이트를 ...
(QB_NEW_FR_OTHER_ERROR_IDS_REPLACEMENT_PUNCTUATION_DASH_–)
[grammar] ~254-~254: Envisagez un remplacement
Context: ...로 Airtable에 업데이트를 작성합니다. - Slack 에이전트 - 채널 메시지에 응답하고 VoltOps Slack 액션으로 답장합니다. - *...
(QB_NEW_FR_OTHER_ERROR_IDS_REPLACEMENT_PUNCTUATION_DASH_–)
[grammar] ~255-~255: Envisagez un remplacement
Context: ...ck 액션으로 답장합니다. - ChatGPT 앱과 VoltAgent - VoltAgent를 MCP를 통해 배포하고 ChatGPT 앱에 연결합니다. - **[Wha...
(QB_NEW_FR_OTHER_ERROR_IDS_REPLACEMENT_PUNCTUATION_DASH_–)
[grammar] ~256-~256: Envisagez un remplacement
Context: ...ev/examples/agents/whatsapp-ai-agent)** - 자연스러운 대화로 음식 주문을 처리하는 WhatsApp 챗봇을 구축합니다. ([소...
(QB_NEW_FR_OTHER_ERROR_IDS_REPLACEMENT_PUNCTUATION_DASH_–)
[grammar] ~256-~256: Il y a peut-être une erreur ici
Context: ...tagent/tree/main/examples/with-whatsapp)) - **[YouTube to 블로그 에이전트](https://voltagent.d...
(QB_NEW_FR)
[grammar] ~257-~257: Envisagez un remplacement
Context: ...with-whatsapp)) - YouTube to 블로그 에이전트 - MCP 도구를 사용한 감독자 에이전트로 YouTube 비디오를 Markdown...
(QB_NEW_FR_OTHER_ERROR_IDS_REPLACEMENT_PUNCTUATION_DASH_–)
[grammar] ~258-~258: Envisagez un remplacement
Context: ...xamples/agents/ai-instagram-ad-agent)** - BrowserBase Stagehand와 Google Gemini AI를 사용하여 Insta...
(QB_NEW_FR_OTHER_ERROR_IDS_REPLACEMENT_PUNCTUATION_DASH_–)
[grammar] ~259-~259: Envisagez un remplacement
Context: ...dev/examples/agents/recipe-generator)** - 재료와 선호도에 따라 개인화된 요리 제안을 만듭니다. ([소스 코드](http...
(QB_NEW_FR_OTHER_ERROR_IDS_REPLACEMENT_PUNCTUATION_DASH_–)
[grammar] ~259-~259: Il y a peut-être une erreur ici
Context: ...r) | 비디오) - **[AI 연구 어시스턴트 에이전트](https://voltagent.dev/...
(QB_NEW_FR)
[grammar] ~260-~260: Envisagez un remplacement
Context: ...v/examples/agents/research-assistant)** - 포괄적인 보고서를 생성하는 멀티 에이전트 연구 워크플로. ([소스 코드](htt...
(QB_NEW_FR_OTHER_ERROR_IDS_REPLACEMENT_PUNCTUATION_DASH_–)
i18n/README-cn-traditional.md
[uncategorized] ~286-~286: 您的意思是“"不"驟”？
Context: ...-14a68ca297fb" /> ### 日誌 追蹤每個代理互動和工作流程步驟的詳細執行日誌。 
[uncategorized] ~310-~310: 数词与名词之间一般应存在量词，可能缺少量词。
Context: ...1-4443-a494-08c33ec9bcc4" /> ### 部署 透過一鍵 GitHub 整合和託管基礎設施將您的代理部署到生產環境。 <img alt...
(wa5)
packages/core/README.md
[style] ~243-~243: ‘new records’ might be wordy. Consider a shorter alternative.
Context: ...les/guides/airtable-agent)** - React to new records and write updates back into Airtable wi...
(EN_WORDINESS_PREMIUM_NEW_RECORDS)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: Test cli
- GitHub Check: Build (Node 22)
- GitHub Check: Build (Node 20)
- GitHub Check: Build (Node 24)
- GitHub Check: Cloudflare Pages
🔇 Additional comments (8)
packages/core/README.md (3)
33-38: Documentation structure and messaging are clear. ✅The introduction effectively communicates VoltAgent's dual nature (open-source framework + platform console) with anchor-linked navigation, making it easy for readers to jump to relevant sections.
74-114: Code examples demonstrate core patterns effectively. ✅The TypeScript setup example and expense approval workflow showcase proper usage of the framework with correct async patterns, type safety via Zod, and practical human-in-the-loop implementation. Examples are well-documented and maintainable.
Also applies to: 150-219
336-354: Updated contributor section maintains community acknowledgment. ✅The expanded "Learning VoltAgent" section and refreshed "Contributor" section (with updated max=500 config and current copyright year 2026-present) properly recognize community contributions and keep licensing information current.
i18n/README-cn-bsc.md (3)
39-48: Chinese localization structure is clear and well-organized. ✅The header, navigation, and section organization mirror the English version well. Anchor links (
#core-framework,#voltops-console) are properly implemented for navigation consistency across localized versions.
249-260: Examples section is well-localized with clear descriptions. ✅All example titles and descriptions are properly translated to Chinese. Links to source code and videos are preserved, making it easy for Chinese-speaking developers to explore practical implementations.
346-367: Learning resources and contributor section maintain localization consistency. ✅The "学习 VoltAgent" (Learning VoltAgent) section provides translated descriptions while preserving links. Copyright year is updated to 2026-present, and the contributor badge is configured appropriately. Localization is complete and consistent across this section.
i18n/README-cn-traditional.md (2)
152-152: Previous image reference issues resolved.The previously flagged
thumbnail.pngreferences have been corrected to use full GitHub asset URLs. Both images should now render correctly.Please verify that both images render correctly in the GitHub preview by checking the markdown preview in your browser.
Also applies to: 233-233
1-50: Content reorganization and documentation improvements look solid.The restructuring improves navigation with new anchor links, clearer section organization, and expanded documentation coverage (Voice, Guardrails, Evals, Knowledge Base, MCP). New Examples section is a valuable addition. License year and contributor image updates are in order. Static analysis hints appear to be false positives.
Also applies to: 50-65, 72-154, 249-260, 262-344, 363-363, 367-367
| <br/> | ||
|
|
||
|  | ||
| <img alt="dashboar" src="https://github.com/user-attachments/assets/c88a5543-219e-4cf0-8f41-14a68ca297fb" /> |
There was a problem hiding this comment.
Fix typo in image alt text.
Line 282 contains a typo: alt="dashboar" should be alt="dashboard". This was flagged in a previous review and should be corrected.
✏️ Proposed fix
-<img alt="dashboar" src="https://github.com/user-attachments/assets/c88a5543-219e-4cf0-8f41-14a68ca297fb" />
+<img alt="dashboard" src="https://github.com/user-attachments/assets/c88a5543-219e-4cf0-8f41-14a68ca297fb" />📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <img alt="dashboar" src="https://github.com/user-attachments/assets/c88a5543-219e-4cf0-8f41-14a68ca297fb" /> | |
| <img alt="dashboard" src="https://github.com/user-attachments/assets/c88a5543-219e-4cf0-8f41-14a68ca297fb" /> |
🤖 Prompt for AI Agents
In @i18n/README-jp.md at line 282, Update the img tag's alt attribute to correct
the typo: change alt="dashboar" to alt="dashboard" in the <img> element shown;
ensure the corrected alt text is used in the same tag so accessibility and
copy/readers reflect "dashboard" accurately.
PR Checklist
Please check if your PR fulfills the following requirements:
Bugs / Features
What is the current behavior?
What is the new behavior?
fixes (issue)
Notes for reviewers
Summary by cubic
Updated root, core, and localized READMEs for clearer messaging and navigation: new banner, cleaner headings, anchor-linked Core Framework and VoltOps sections, and a richer Quick Start with a human-in-the-loop workflow example.
Added Voice, Guardrails, Evals, Knowledge Base, and MCP docs links; expanded VoltOps Console content (observability, triggers/actions, monitoring, prompts, deploy, RAG), refreshed screenshots/thumbnails, removed stars badge/extra breaks, and updated contributors image and license year.
Written for commit a549766. Summary will update on new commits.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.