Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: fix broken README links to recipes-and-guides#1325

Merged
omeraplak merged 1 commit into
VoltAgent:mainfrom
putramkti:docs/fix-broken-recipes-and-guides-links
May 29, 2026
Merged

docs: fix broken README links to recipes-and-guides#1325
omeraplak merged 1 commit into
VoltAgent:mainfrom
putramkti:docs/fix-broken-recipes-and-guides-links

Conversation

@putramkti
Copy link
Copy Markdown

@putramkti putramkti commented May 29, 2026

What is the current behavior?

The README and its translated copies link to two recipe pages under the old /examples/guides/ path:

  • https://voltagent.dev/examples/guides/airtable-agent → 404
  • https://voltagent.dev/examples/guides/slack-agent → 404

The recipes plugin in website/docusaurus.config.ts exposes these pages under routeBasePath: "recipes-and-guides", and the file website/docusaurus.config.ts already maps /recipes/slack-agent//recipes-and-guides/slack-agent/, but there is no redirect from the /examples/guides/... paths used by the README, so the links land on a 404.

What is the new behavior?

Updates the README links (English + 5 i18n copies) to the canonical /recipes-and-guides/<slug> URLs:

  • https://voltagent.dev/recipes-and-guides/airtable-agent
  • https://voltagent.dev/recipes-and-guides/slack-agent

Pages confirmed at website/recipes/airtable-agent.md and website/recipes/slack-agent.md, and registered in website/sidebarsRecipes.ts.

Notes for reviewers

  • Docs-only change, no source / build / test impact (precedent: chore: update README #923 README+i18n update merged without a changeset).
  • Diff is +10/-10 across README.md + the four i18n/README-*.md translations.
  • Did not add a redirect because the /examples/guides/... paths weren't in the existing from: lists; happy to add one if preferred over the README edit.

PR Checklist

  • The commit message follows our guidelines
  • Docs have been added / updated

Summary by cubic

Fix broken Airtable Agent and Slack Agent links in the README and all i18n copies. Updated URLs to https://voltagent.dev/recipes-and-guides/airtable-agent and https://voltagent.dev/recipes-and-guides/slack-agent so they no longer 404.

Written for commit 6d1fe2d. Summary will update on new commits.

Review in cubic

Summary by CodeRabbit

  • Documentation
    • Updated Airtable and Slack agent documentation links across multiple language versions of the README.

Review Change Stack

The Airtable Agent and Slack Agent links in README.md and all i18n
variants pointed to /examples/guides/<slug> which returns 404. The
recipes plugin in website/docusaurus.config.ts uses
routeBasePath: 'recipes-and-guides' (line 160), and existing redirects
at lines 467-471 and 531-557 confirm /examples/guides/* was never a
valid route. Updates the 5 README files to use the correct
/recipes-and-guides/<slug> path.

Affected:
- README.md (lines 254-255)
- i18n/README-cn-bsc.md
- i18n/README-cn-traditional.md
- i18n/README-jp.md
- i18n/README-kr.md
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 29, 2026

⚠️ No Changeset found

Latest commit: 6d1fe2d

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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 29, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 6ebd0c8a-e7bb-41fd-bda8-7c612dbbbb94

📥 Commits

Reviewing files that changed from the base of the PR and between 5be7626 and 6d1fe2d.

📒 Files selected for processing (5)
  • README.md
  • i18n/README-cn-bsc.md
  • i18n/README-cn-traditional.md
  • i18n/README-jp.md
  • i18n/README-kr.md

📝 Walkthrough

Walkthrough

This PR updates example documentation links for Airtable and Slack agents across all README variants (English and four internationalized locales). The changes migrate link paths from /examples/guides/... to /recipes-and-guides/... for consistency with renamed documentation structure.

Changes

Documentation link migration

Layer / File(s) Summary
Airtable and Slack agent guide links
README.md, i18n/README-cn-bsc.md, i18n/README-cn-traditional.md, i18n/README-jp.md, i18n/README-kr.md
Example documentation URLs for Airtable and Slack agents are updated from /examples/guides/... to /recipes-and-guides/... across the main English README and all internationalized variants.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • VoltAgent/voltagent#923: Earlier README documentation link restructuring work that may have introduced the new /recipes-and-guides/ path structure.
  • VoltAgent/voltagent#919: Broader README documentation and link reorganization effort related to the same documentation restructuring initiative.

Poem

🐰 Links dance from /examples/guides/ old,
To /recipes-and-guides/ stories retold,
In English, Chinese, Japanese, Korean alike—
Five READMEs aligned, documentation delight! 📚✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and concisely describes the main change: fixing broken README links by updating URLs from /examples/guides/ to /recipes-and-guides/.
Description check ✅ Passed The description comprehensively addresses all template requirements with clear explanations of current and new behavior, implementation details, and relevant notes for reviewers.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

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

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 and usage tips.

Copy link
Copy Markdown
Contributor

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

Choose a reason for hiding this comment

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

No issues found across 5 files

Re-trigger cubic

Copy link
Copy Markdown
Member

@omeraplak omeraplak left a comment

Choose a reason for hiding this comment

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

thank yo so much 🔥

@omeraplak omeraplak merged commit 41cad53 into VoltAgent:main May 29, 2026
21 of 23 checks passed
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