-
-
Notifications
You must be signed in to change notification settings - Fork 216
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
Doc improve objects
guide with extraction and composition patterns
#991
base: main
Are you sure you want to change the base?
Doc improve objects
guide with extraction and composition patterns
#991
Conversation
Thank you very much! I think I would move it before the |
Yes this sounds good to me, That make sense as there's a dedicated guide about arrays on the next page. This being said i could add similar sections to the array guide as the way to access nested schema change between the two. |
…m/Bilboramix/valibot into doc-object-extraction-composition
Another option would be to add an extra guide explaining the accessibility of schemas in general instead of adding it everywhere. |
Yeah that can make sense. I can change to this idea. |
We could also call this guide "Internals" or something else in that direction. At the time of implementation, we called it the "Schema Reflection API". On the other hand, I think library authors and hardcore users will be most interested in this guide. I don't have a perfect title yet, but I recommend that I write the first version of this guide as I have the most knowledge on this regards. But I am happy to create a PR and receive feedback before publishing it. |
I think "Reflection" could be a good name, internal sounds weird to me but maybe because i'm not a native english speaker. |
Let's see how it goes. Maybe we merge this PR too to add some info to the objects guide in addition. |
Yeah ok. For more advanced use cases we could put a link to the next guide here maybe, to avoid too much repetitive content. How to :And so on... I realize the responsibility you got as an author to pick the right descisions and to compose with what the community want, all the ideas submitted and ensure that the lib and the doc keep a good quality. Massive respect ! |
Great idea! I agree there is room for improvement. In the long run we should add a "copy" button to the code examples and maybe also an "open in playground" button.
Thank you very much! Yes, it is not always an easy task. With more and more users, the responsibility also increases. That's why I have to slow down a lot of decisions. Prioritizing the right things and keeping an eye on quality will be very important for the success of the project in the long run. |
The "Reflection API" guide is on my list, but I can't tell you when I will find the time to write it. Right now I am trying to focus on important fixes and getting Valibot v1 RC ready. |
Related issue: #256 |
On the discord server we've seen few questions about how to extract a field's schema from an
object
.Fabian suggested to explain it in the objects guide so here it is.