-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
docs: Add documentation for zod type provider #4456
Merged
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
eda15a2
Add documentation for zod type provider
kibertoad 50dd214
Fix casing
kibertoad bd1517a
Restore lost text
kibertoad 24463e5
Remove whitespace
kibertoad 5d6b92b
Fix install
kibertoad 251115c
Merge branch 'main' into docs/zod
Fdawgs 6edd033
Adjust documentation
kibertoad 9b44b54
Merge branch 'main' of https://github.com/fastify/fastify into docs/zod
kibertoad File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains 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
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.
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.
I'd mention this is not an official package.
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.
I agree. And would we be adding a section here for every community module? I'm not sure this documentation belongs here. The module itself should explain how to use it.
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.
I agree, but discoverability is an important thing too.
Would it be better if code sample was replaced with a link to zod provider repo?
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.
I see it is already listed under https://www.fastify.io/ecosystem/. Are you wanting to create another such list in this document?
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.
this part of documentation already has a list, which gives a false impression of what type providers exist.
not everyone going to go through a random dump of ecosystem doc
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.
Surprising fact (😉): I have not paid this doc any attention. The only reason I have given any review of it this time is because you specifically asked me for one.
I think it is a mistake to have two lists with the same information in the documentation. In my opinion, we'd either note here that folks should review the ecosystem list for modules named as described, or update the ecosystem doc to remove any type providers in that list and add a section that states "see this other doc for the list".
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.
what do you think about adding "type provider" section to ecosystem doc and linking it from here?
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.
Yeah, that sounds good too.