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.

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

Restructure what is JSON Schema for clarity #679

Merged
merged 9 commits into from May 21, 2024

Conversation

Nickyshe
Copy link
Contributor

@Nickyshe Nickyshe commented Apr 26, 2024

What kind of change does this PR introduce?
This issue is for restructuring and rewriting what is Json schema page for clarity, consistent use of pronouns, revamp headings and ensure the tone is consistent throughout the documentation

Issue Number:

Screenshots/videos:

Screenshot (528)

If relevant, did you update the documentation?

Yes I updated the documentation

@Nickyshe Nickyshe requested a review from a team as a code owner April 26, 2024 08:21
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to the JSON Schema Community. Thanks a lot for creating your first pull request!! 🎉🎉 We are so excited you are here! We hope this is only the first of many! For more details check out README.md file.

Copy link
Collaborator

@benjagm benjagm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot Judith! This has been a great start. I added some comments:

  • How it works:
    • Add the missing image.
    • Add section tittle and paragraph for context.
  • We need to rephrase the titles of the benefits for developers and organizations to match the format "JSON Schema enable developers to ..." and "JSON Schema enable organizations to ..."

Excellent work so far. THANKS!

pages/overview/what-is-jsonschema.md Outdated Show resolved Hide resolved
pages/overview/what-is-jsonschema.md Outdated Show resolved Hide resolved
pages/overview/what-is-jsonschema.md Outdated Show resolved Hide resolved
pages/overview/what-is-jsonschema.md Outdated Show resolved Hide resolved
pages/overview/what-is-jsonschema.md Outdated Show resolved Hide resolved
pages/overview/what-is-jsonschema.md Outdated Show resolved Hide resolved
@benjagm benjagm added the Status: In Progress This issue is being worked on, and has someone assigned. label Apr 30, 2024
Copy link
Collaborator

@benjagm benjagm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking great @Nickyshe The simplification of the messaging makes it easier for readers to through all the content.

The only area I think we should continue working on "How JSON Schema works?" and for it I left some comments are suggestions.

Great job! We are very close!!

pages/overview/what-is-jsonschema.md Outdated Show resolved Hide resolved
pages/overview/what-is-jsonschema.md Outdated Show resolved Hide resolved
pages/overview/what-is-jsonschema.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@benjagm benjagm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent job Judith! Thanks.

This looks great to me. I just pushed a small change to change the location of the image and fix 1 typo.

pages/overview/what-is-jsonschema.md Outdated Show resolved Hide resolved
pages/overview/what-is-jsonschema.md Outdated Show resolved Hide resolved
@benjagm benjagm merged commit d3cd636 into json-schema-org:main May 21, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: In Progress This issue is being worked on, and has someone assigned.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Restructure and rewrite What is JSON Schema Page in the overview section of the documentation for clarity
2 participants