Skip to content

docs: fix missing Zod v4 import examples in package READMEs#103

Open
Sertug17 wants to merge 1 commit into
agentcommercekit:mainfrom
Sertug17:docs/fix-schema-validation-examples
Open

docs: fix missing Zod v4 import examples in package READMEs#103
Sertug17 wants to merge 1 commit into
agentcommercekit:mainfrom
Sertug17:docs/fix-schema-validation-examples

Conversation

@Sertug17
Copy link
Copy Markdown

@Sertug17 Sertug17 commented May 20, 2026

Summary

Across 6 package READMEs, the Schema Validation code examples have the Zod v4 import missing. The // Zod v4 comment exists but is followed by an empty line, then the Valibot import — making it appear that Zod v4 has no import path. The actual Zod v4 import is misplaced at the bottom, detached from its comment.

Before (all 6 packages)

// Zod v4 schemas
                          <-- empty line, no import
// Valibot schemas
import { ... } from ".../schemas/valibot"
// Zod v3 schemas
import { ... } from ".../schemas/zod/v3"
import { ... } from ".../schemas/zod/v4"   <-- orphaned at bottom

After

// Zod v4 schemas
import { ... } from ".../schemas/zod/v4"   <-- now under its comment
// Zod v3 schemas
import { ... } from ".../schemas/zod/v3"
// Valibot schemas
import { ... } from ".../schemas/valibot"

Affected packages

  • @agentcommercekit/caip
  • @agentcommercekit/did
  • @agentcommercekit/jwt
  • @agentcommercekit/vc
  • @agentcommercekit/ack-id
  • @agentcommercekit/ack-pay

Summary by CodeRabbit

  • Documentation
    • Standardized schema validation code examples across package documentation to present library imports (Zod v4, Zod v3, and Valibot) in a consistent order, improving documentation clarity and consistency.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 20, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 357b8b10-24ce-405f-b944-3c5d9e8b25f5

📥 Commits

Reviewing files that changed from the base of the PR and between 6f65936 and e520a62.

📒 Files selected for processing (6)
  • packages/ack-id/README.md
  • packages/ack-pay/README.md
  • packages/caip/README.md
  • packages/did/README.md
  • packages/jwt/README.md
  • packages/vc/README.md

Walkthrough

Six package READMEs were updated to standardize schema validation import examples. Each "Schema Validation" code snippet was reordered to show Zod v4 imports before Zod v3, with Valibot imports last, across ack-id, ack-pay, caip, did, jwt, and vc packages.

Changes

Schema Validation Example Import Order

Layer / File(s) Summary
Schema validation example import reordering
packages/ack-id/README.md, packages/ack-pay/README.md, packages/caip/README.md, packages/did/README.md, packages/jwt/README.md, packages/vc/README.md
Updated schema validation code examples across packages to reorder imports: Zod v4 appears first, followed by Zod v3, with Valibot imports positioned last in each example.

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title accurately describes the main change: fixing the organization of Zod v4 import examples across package READMEs.
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.

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.

1 participant