docs: update naming & README #919
Conversation
…contributor visibility
Added an image and a screenshot to the README.
Added multiple images to the Dashboard section for better visualization.
Added demo images for VoltAgent and updated workflow instructions.
… better visibility
|
This comment has been minimized.
This comment has been minimized.
Deploying voltagent with
|
| Latest commit: |
ce9efdb
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://5b413137.voltagent.pages.dev |
| Branch Preview URL: | https://update-naming.voltagent.pages.dev |
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
2 issues found across 4 files
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="README.md">
<violation number="1" location="README.md:45">
P3: Grammar error: "a end-to-end" should be "an end-to-end" since "end" starts with a vowel sound.</violation>
</file>
<file name="website/src/components/hero/index.tsx">
<violation number="1" location="website/src/components/hero/index.tsx:110">
P2: Invalid Tailwind spacing value `mb-18`. The value `18` is not in Tailwind's default spacing scale (goes 16, 20). Use `mb-16`, `mb-20`, or an arbitrary value like `mb-[4.5rem]`.</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>
📝 WalkthroughWalkthroughThis pull request rebrands VoltAgent as an AI Agent Engineering Platform, updates README content and imagery, restructures the website hero with a new Platform Container and styling adjustments, and removes three footer navigation links. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI Agents
In @README.md:
- Line 53: The phrase in the "Code with Confidence" blurb uses "compile time
safety" as a compound adjective; update that phrase to "compile-time safety" so
the sentence reads "...automatic inference, and compile-time safety across your
entire agent system." Replace the unhyphenated "compile time safety" with
"compile-time safety" in the "Code with Confidence" line.
In @website/src/components/hero/index.tsx:
- Around line 142-144: The className string in the Hero component contains
duplicate/conflicting Tailwind letter-spacing classes (tracking-[-0.65px] and
tracking-[-0.025em]); remove the unwanted duplicate so only one tracking utility
remains (e.g., delete tracking-[-0.65px] and keep tracking-[-0.025em]) in the
template literal that builds className (the element using isVisible for
opacity/translate).
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
README.mdwebsite/src/components/footer/index.tsxwebsite/src/components/hero/index.tsxwebsite/src/pages/index.tsx
💤 Files with no reviewable changes (2)
- website/src/components/footer/index.tsx
- website/src/pages/index.tsx
🧰 Additional context used
🧬 Code graph analysis (1)
website/src/components/hero/index.tsx (2)
website/src/components/magicui/line-shadow-text.tsx (1)
LineShadowText(11-42)website/src/components/agents-animation/index.tsx (1)
AgentsAnimation(550-1035)
🪛 LanguageTool
README.md
[grammar] ~53-~53: Use a hyphen to join words.
Context: ... tools, automatic inference, and compile time safety across your entire agent sys...
(QB_NEW_EN_HYPHEN)
[style] ~267-~267: ‘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). (8)
- GitHub Check: Test cli
- GitHub Check: Test libsql
- GitHub Check: Test core
- GitHub Check: Build (Node 20)
- GitHub Check: Build (Node 22)
- GitHub Check: Build (Node 24)
- GitHub Check: Lint (Node 24)
- GitHub Check: Cloudflare Pages
🔇 Additional comments (4)
website/src/components/hero/index.tsx (1)
202-275: LGTM! Well-structured Platform Container section.The new Platform Container effectively presents the dual-component architecture (Core Framework + VoltOps Console) with:
- Clean responsive grid layout (1-column mobile, 3-column desktop)
- Semantic HTML with proper accessibility
- Consistent styling and spacing
- Clear visual hierarchy with badges, pills, and feature lists
The implementation aligns well with the PR's rebranding objectives.
README.md (3)
45-96: Excellent rebranding and restructuring.The updated introduction clearly positions VoltAgent as an end-to-end AI Agent Engineering Platform, effectively distinguishing:
- The open-source TypeScript framework (Memory, RAG, tools, runtime)
- VoltOps capabilities (observability, automation, deployment)
The "Why VoltAgent?" section benefits are well-articulated, and the expanded feature descriptions provide clearer value propositions. The structure supports both developers evaluating the framework and teams planning production deployments.
263-275: Well-organized Examples section.The consolidated examples provide clear entry points with links to both documentation and source code. The variety (Airtable, Slack, ChatGPT, WhatsApp, YouTube, ads, recipes, research) demonstrates the framework's versatility across different use cases and integration patterns.
166-166: Fix missing image assets in README.md.Lines 166 and 247 reference
thumbnail.png, which does not exist in the repository. The images should either be downloaded and stored locally with distinct filenames (e.g.,volt-agent-demo.pngandexpense-approval-workflow.png), or the references should be updated to use the full GitHub asset URLs directly. Currently, the images will fail to render properly.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
…into update-naming
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
267-267: Consider shortening "new records" for concision (optional refactor).The phrase "React to new records and write updates back into Airtable" could be slightly more concise. The static analysis tool suggests "new records" may be wordy. If you'd like to tighten the prose, consider alternatives like "React to record additions" or similar. This is optional and a minor style improvement.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
README.mdwebsite/src/components/hero/index.tsx
🚧 Files skipped from review as they are similar to previous changes (1)
- website/src/components/hero/index.tsx
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~267-~267: ‘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). (8)
- GitHub Check: Test server-core
- GitHub Check: Test core
- GitHub Check: Test voice
- GitHub Check: Build (Node 24)
- GitHub Check: Lint (Node 24)
- GitHub Check: Build (Node 20)
- GitHub Check: Build (Node 22)
- GitHub Check: Cloudflare Pages
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
Refresh naming and messaging to position VoltAgent as an end-to-end AI Agent Engineering Platform, and align README and website copy for clarity and consistency.
Docs
Refactors
Written for commit ce9efdb. Summary will update on new commits.
Summary by CodeRabbit
Documentation
New Features
Style
Chores
✏️ Tip: You can customize this high-level summary in your review settings.