Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[📝 Docs]: Create a guide to use the JSON Schema Test Suite #1093

Open
1 task done
valeriahhdez opened this issue Nov 6, 2024 · 3 comments
Open
1 task done

[📝 Docs]: Create a guide to use the JSON Schema Test Suite #1093

valeriahhdez opened this issue Nov 6, 2024 · 3 comments
Labels
📝 Documentation Indicates improvements or additions to documentation. Status: Available No one has claimed responsibility for resolving this issue.
Milestone
Docs Release 8

Comments

@valeriahhdez
Copy link
Contributor

What Docs changes are you proposing?

Create a comprehensive guide to teach implementers how to use the JSON Schema Test Suite during the development of reliable JSON Schema validators.

Code of Conduct

  • I agree to follow this project's Code of Conduct
@valeriahhdez valeriahhdez added 📝 Documentation Indicates improvements or additions to documentation. Status: Triage This is the initial status for an issue that requires triage. labels Nov 6, 2024
@valeriahhdez valeriahhdez added this to the Docs Release 8 milestone Nov 6, 2024
@valeriahhdez valeriahhdez moved this to Todo in JSON Schema Docs Nov 6, 2024
@valeriahhdez valeriahhdez added Status: Available No one has claimed responsibility for resolving this issue. and removed Status: Triage This is the initial status for an issue that requires triage. labels Nov 7, 2024
@harshita9104
Copy link

Hello @valeriahhdez ,
I hope this message finds you well !!

I am currently working as Technical writer at Atlan and would like to contribute to this documentation, could you please help me with providing the necessary requirements and link of current available documentation on a related topic so that i can figure out what should i actually focus on!!

Thanking you in Anticipation!

@harshita9104
Copy link

Hello @valeriahhdez

Kindly assign this issue to me!

Thank you

@valeriahhdez valeriahhdez moved this from Todo to Idea in JSON Schema Docs Jan 11, 2025
@Vineet1101
Copy link

@valeriahhdez @DhairyaMajmudar I have basic heading which I think should be needed for making this guide

  1. Introduction
  2. Overview of the JSON Schema Test Suite
  3. Getting Started
  4. Running the Tests
  5. Interpreting Results
  6. Tips for Validator Development
  7. Advanced Topics
  8. Resources
  9. Conclusion

please tell if there are any modifications you need in it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
📝 Documentation Indicates improvements or additions to documentation. Status: Available No one has claimed responsibility for resolving this issue.
Projects
JSON Schema Docs
Status: Idea
Milestone
Docs Release 8
Development

No branches or pull requests
3 participants
@valeriahhdez @harshita9104 @Vineet1101