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
✨ Enhancement: Rebuild the getting started guide #549
Labels
✨ Enhancement
Indicates that the issue suggests an improvement or new feature.
Status: Available
No one has claimed responsibility for resolving this issue.
Comments
benjagm
added
✨ Enhancement
Indicates that the issue suggests an improvement or new feature.
Status: Triage
This is the initial status for an issue that requires triage.
labels
Mar 16, 2024
benjagm
added
Status: In Progress
This issue is being worked on, and has someone assigned.
and removed
Status: Triage
This is the initial status for an issue that requires triage.
labels
Mar 16, 2024
Hello @benjagm, can I help you with this in any way. |
Thanks Vivek. I still need to find some time to create a prototype with what I have in mind. |
benjagm
added
Status: Available
No one has claimed responsibility for resolving this issue.
and removed
Status: In Progress
This issue is being worked on, and has someone assigned.
labels
Apr 17, 2024
Hey @benjagm can I work on this? |
My apologies for the late response. I think @DhairyaMajmudar is working on this. Isn't it? |
Yes I am currently working on this. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
✨ Enhancement
Indicates that the issue suggests an improvement or new feature.
Status: Available
No one has claimed responsibility for resolving this issue.
Is your feature request related to a problem? Please describe
We are aware that learning JSON Schema is not easy and we also know that our docs needs a lot of improvement. But now, with the new feedback component we are even more clear about the areas that needs improvement and the getting started guide is clearly one of them.
After long consideration, I think the best approach is proceeding with a first iteration consisting on changing the section Validating JSON data against the schema.
We don't maintain or promote any validator over others and in addition we are not integrating any validator. This is great to keep our neutrality but it adds friction into new users journey. We are going to keep that neutrality but it will be great to allow the users feel the HAHA moment of getting a json message validated against a schema.
My proposal is to create a component that provides different valid and invalid examples for different uses cases following this prototype:
The default example shown by the component is the one used for getting started. Considering that the examples are pre-recorded and we know the validation result.
The idea is let the users see the power of the json schema validation and show other real life examples to inspire them.
The text was updated successfully, but these errors were encountered: