-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
docs: fix typos and links #5428
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
WalkthroughThis PR updates the documentation across a few files. The CONTRIBUTING.md file now points to the documentation site at packages/docs instead of referencing README.md. In the API documentation, a typo was corrected—"deciams" is now properly spelled as "decimals" in the ISO time description. Finally, the v4 documentation was updated with a formatting improvement, converting a plain inline link to a proper markdown hyperlink for the locales reference while keeping the same anchor target. All changes are documentation-focused with no code logic modifications. Pre-merge checks❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
80-81: Documentation path update looks good, but the formatting could be clearer.The parenthetical notation
packages/docs(content in packages/docs/content)is a bit awkward. Consider using something like:packages/docswith content located atpackages/docs/contentfor better readability.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
CONTRIBUTING.md(1 hunks)packages/docs/content/api.mdx(1 hunks)packages/docs/content/v4/index.mdx(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-10-21T17:28:01.210Z
Learnt from: CR
Repo: colinhacks/zod PR: 0
File: .cursor/rules/zod-project-guide.mdc:0-0
Timestamp: 2025-10-21T17:28:01.210Z
Learning: Applies to packages/zod/** : Make core Zod library changes in the main package at packages/zod/
Applied to files:
CONTRIBUTING.md
📚 Learning: 2025-10-21T17:24:39.708Z
Learnt from: CR
Repo: colinhacks/zod PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-10-21T17:24:39.708Z
Learning: Applies to packages/zod/package.json : Provide the zod/source export condition pointing to TypeScript source for development
Applied to files:
CONTRIBUTING.md
🔇 Additional comments (2)
packages/docs/content/api.mdx (1)
469-469: Good catch on the typo!Correcting "deciams" to "decimals" improves clarity in the ISO time description.
packages/docs/content/v4/index.mdx (1)
601-601: Nice—converting to markdown link syntax improves consistency!The hyperlink formatting using
[Customizing errors](/error-customization#locales)is cleaner and maintains consistency across the documentation.
No description provided.