[📝 Docs]: Create a guide for Bowtie

[valeriahhdez]

What Docs changes are you proposing?

Write a guide that teaches implementers how to use Bowtie to test schemas across validator implementations.

Code of Conduct

• [X] I agree to follow this project's Code of Conduct

[techmannih]

Hey @valeriahhdez, I’m interested. Firstly, can we discuss this issue?

[shantanu2107]

Hi @valeriahhdez , can I work on this issue if no one is working?

[harshita9104]

Hello @valeriahhdez

Kindly assign this issue to me!

I propose adding a new section to the documentation titled "Testing Schemas Across Validator Implementations." This section will provide a concise and practical guide for implementers on how to leverage Bowtie to validate JSON schemas using multiple validator implementations. The steps will be outlined clearly with examples to ensure usability.

Proposed Structure: Introduction: Briefly explain the purpose of testing schemas across validators using Bowtie and the value it provides (e.g., ensuring compatibility and compliance).

Setting Up Bowtie:

Quick recap of installation methods (Homebrew, pipx, etc.) for easy onboarding. Highlight the cloud options (GitHub Codespaces/Gitpod) for users who want to try Bowtie without local installation. Using Bowtie for Schema Validation:

Step-by-step guide to running Bowtie, including: Providing a schema file. Specifying which validator implementations to test.

Analyzing Results:

How to interpret the Bowtie report. Troubleshooting common validation issues

[valeriahhdez]

Yes, you can @harshita9104. Please check the recent discussion for the requirements of this guide in the #documentation Slack channel

[DhairyaMajmudar]

@harshita9104 can updates on this?

[vtushar06]

Hi @valeriahhdez, I noticed there hasn’t been recent activity from the previously assigned contributor. May I take up this issue and work on the Bowtie guide? Please let me know if it’s available. Thank you!