✨ Enhancement: Rebuild the getting started guide #549
Description
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.
- Initially the component shows the default schema instance. (this will be paremetrized in a yaml file)
- The user can select 2 or 3 different instances, valid and invalid and we show the result and the explanation why showing a green check when is valid and red cross when is invalid.
- We'll provide some other schema examples with instances so the users can see it working in different scenarios. We add simple and other more complex examples.
- We provide a download button to allow to download the schema and the selected instance so the user can try it with the validator of their choice.
The idea is let the users see the power of the json schema validation and show other real life examples to inspire them.