docs: add README.md for @ai-sdk/mcp, @ai-sdk/otel, and @ai-sdk/voyage#15004
Closed
Mmartinrusso wants to merge 1 commit into
Closed
docs: add README.md for @ai-sdk/mcp, @ai-sdk/otel, and @ai-sdk/voyage#15004Mmartinrusso wants to merge 1 commit into
Mmartinrusso wants to merge 1 commit into
Conversation
Adds missing README.md files for the three packages excluded from the konsistent convention check, and removes them from the excludeFiles list so the convention is now enforced for all packages. Closes vercel#14859 (README.md portion) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Background
Three packages —
@ai-sdk/mcp,@ai-sdk/otel, and@ai-sdk/voyage— were missingREADME.mdfiles and were excluded from thekonsistentconvention check that requires every package to have a README.Summary
README.mdforpackages/mcpwith MCP client usage exampleREADME.mdforpackages/otelwith OpenTelemetry usage exampleREADME.mdforpackages/voyagewith embedding usage exampleexcludeFileslist in.github/konsistent.jsonso the README convention is now enforced for all packagesManual Verification
packages/mcp/README.mdexists ✓packages/otel/README.mdexists ✓packages/voyage/README.mdexists ✓.github/konsistent.jsonexclusion list no longer contains these packages ✓Checklist
Related Issues
Closes #14859 (README.md portion)
🤖 Generated with Claude Code