docs: fix broken README links to recipes-and-guides#1325
Conversation
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
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
📝 WalkthroughWalkthroughThis 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 ChangesDocumentation link migration
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
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→ 404https://voltagent.dev/examples/guides/slack-agent→ 404The recipes plugin in
website/docusaurus.config.tsexposes these pages underrouteBasePath: "recipes-and-guides", and the filewebsite/docusaurus.config.tsalready 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-agenthttps://voltagent.dev/recipes-and-guides/slack-agentPages confirmed at
website/recipes/airtable-agent.mdandwebsite/recipes/slack-agent.md, and registered inwebsite/sidebarsRecipes.ts.Notes for reviewers
README.md+ the fouri18n/README-*.mdtranslations./examples/guides/...paths weren't in the existingfrom:lists; happy to add one if preferred over the README edit.PR Checklist
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