Skip to content

docs: fix typos in READMEs, examples and blog posts - #1450

Open
toyeshhm wants to merge 1 commit into
VoltAgent:mainfrom
toyeshhm:fix-doc-typos
Open

toyeshhm wants to merge 1 commit into
VoltAgent:mainfrom
toyeshhm:fix-doc-typos

Conversation

@toyeshhm

@toyeshhm toyeshhm commented Oct 12, 2026 •

Copy link
Copy Markdown

PR Checklist

Please check if your PR fulfills the following requirements:

Bugs / Features

What is the current behavior?

A handful of typos in the READMEs, an example, two recipe pages and two blog posts:

  • examples/with-a2a-server/README.md says the A2AServer exposes "message/taks endpoints".
  • README.md, i18n/README-jp.md and i18n/README-kr.md have alt="dashboar" on the VoltOps screenshot. The two Chinese READMEs already use alt="dashboard".
  • website/recipes/whatsapp-order.md and website/examples/whatsapp-order.md link to the "VoltOps LLM Observability platfrom".
  • website/blog/2025-05-01-voltagent-marketplace/index.md has "Accesible Solutions".
  • website/blog/2025-07-20-llm-evaluation/index.md has "programatically".

What is the new behavior?

Each of the above is corrected: "message/task endpoints", alt="dashboard", "platform", "Accessible", "programmatically".

Notes for reviewers

Markdown only, one line per file. No changeset added since no package is affected.


Summary by cubic

Fixes typos across READMEs, examples, recipes, and blog posts without affecting any code.

  • Corrects "message/taks" to "message/task" in the a2a-server example README.
  • Fixes image alt text "dashboar" to "dashboard" in README.md, i18n/README-jp.md, and i18n/README-kr.md.
  • Corrects "platfrom" to "platform" in the WhatsApp order recipe and example.
  • Fixes "Accesible" to "Accessible" and "programatically" to "programmatically" in two blog posts.

Written for commit b5a07c9. Summary will update on new commits.

View guided diff

Summary by CodeRabbit

  • Documentation
    • Corrected spelling and typos across dashboard image descriptions, server documentation, blog posts, and WhatsApp setup guides.

- examples/with-a2a-server: "message/taks endpoints" -> "message/task endpoints"
- README and i18n READMEs (jp, kr): image alt text "dashboar" -> "dashboard"
- whatsapp-order recipe and example: "platfrom" -> "platform"
- blog: "Accesible" -> "Accessible", "programatically" -> "programmatically"
Copilot AI balanced review requested due to automatic review settings October 12, 2026 21:02
@changeset-bot

changeset-bot Bot commented Oct 12, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: b5a07c9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@coderabbitai

coderabbitai Bot commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: ade75756-163f-4fb0-8493-3e8b81c5d0da

📥 Commits

Reviewing files that changed from the base of the PR and between 72a46c7 and b5a07c9.


📒 Files selected for processing (8)
  • README.md
  • examples/with-a2a-server/README.md
  • i18n/README-jp.md
  • i18n/README-kr.md
  • website/blog/2025-05-01-voltagent-marketplace/index.md
  • website/blog/2025-07-20-llm-evaluation/index.md
  • website/examples/whatsapp-order.md
  • website/recipes/whatsapp-order.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.



📝 Walkthrough

Walkthrough

This change corrects spelling in README text, image alt text, and website content. It does not change image URLs or the descriptions of the affected website content.

Changes

Documentation copy corrections

Layer / File(s) Summary
README text corrections
README.md, i18n/README-*, examples/with-a2a-server/README.md
Corrects dashboard image alt text in the English, Japanese, and Korean READMEs. Corrects the A2AServer endpoint description.
Website text corrections
website/blog/*, website/examples/whatsapp-order.md, website/recipes/whatsapp-order.md
Corrects spelling in a blog bullet, a human-evaluation section, and two WhatsApp guide links.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: omeraplak


Merge Risk: ⚪ Minimal · up to b5a07

The documentation corrections introduce no identified behavior or operational risk, so the PR appears ready to merge after normal checks.

Pre-merge checks · Passed 5
Passed Passed checks (5 passed)
Check name Status Explanation
Title check Passed The title clearly identifies a documentation typo-fix change across READMEs, examples, and blog posts. It omits recipe files but remains concise and directly related to the changes.
Description check Passed The description follows the required template, identifies the current and new behavior, documents each typo correction, records reviewer notes, and explains why no changeset or tests were added. The u…
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 8 files

View guided diff | Re-trigger cubic

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants