Update docs and README to encourage using @openai/zod - ref #187

[seratch]

To prevent users from being confused with the zod latest version incompatibility, this pull request updates all the code snippets in this repo to use @openai/zod, which is the best workaround for #187 issue at this moment.

[changeset-bot]

⚠️ No Changeset found

Latest commit: a42b329

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

[seratch]

Still trying to eliminate the issue, but I haven't yet found a viable solution for it.

[dkundel-openai]

This seems odd? I introduced @openai/zod to explicitly be used for internal purposes only. Meaning it should only be used for things like parsing/validating protocols. For anything inferred like Structured Outputs and tool arguments it intentionally uses zod in the code bases as to use the peer dependency that we expect customers to install. So asking someone to use @openai/zod is essentially relying on an internal abstraction that might break (for example we might bump it to zod 4 if we decided it served our use cases better)

[seratch]

Yeah, this makes sense and this is why I wanted to know your thoughts on this idea. Let's continue exploring both short-term workaround and fundamental solutions for this issue.