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

add introductory guide to JSON Schema #1148

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

techmannih
Copy link
Contributor

@techmannih techmannih requested a review from a team as a code owner December 2, 2024 17:04
@valeriahhdez valeriahhdez self-requested a review December 12, 2024 10:44
@techmannih
Copy link
Contributor Author

@valeriahhdez please review this PR

@valeriahhdez
Copy link
Contributor

@valeriahhdez please review this PR

Hi @techmannih,

Yes, I'll review it.

@DhairyaMajmudar
Copy link
Member

@techmannih it seems like ci checks are failing pls. fix them

Copy link

github-actions bot commented Dec 21, 2024

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
website ✅ Ready (View Log) Visit Preview 7fd610b

Copy link

codecov bot commented Dec 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (8676fc2) to head (7fd610b).

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1148   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           10        10           
  Lines          373       373           
  Branches        94        94           
=========================================
  Hits           373       373           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@techmannih
Copy link
Contributor Author

@DhairyaMajmudar done

@techmannih it seems like ci checks are failing pls. fix them

Copy link
Contributor

@valeriahhdez valeriahhdez left a comment

Choose a reason for hiding this comment

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

Hi @techmannih,

This is a good starting point!

I left some line comments but here are my high-level observations:

  • It seems to me the document lacks clear goals where the reader starts at point A and finishes at point B.
  • Because of this, the document jumps from very basic (empty schema) to complex (nested objects) without a clear progression.
  • It needs to be improved to build knowledge incrementally.
  • In some parts of the text, ideas don't flow naturally, for example when you talk about $ref keyword.
  • It needs to be revised for style. I invite you to read and consult from time to time our style guide.

But overall, I think this is a good first draft. Let me know if you have any questions about these comments.

I look forward to the next iteration of improvements!

pages/understanding-json-schema/introduction.md Outdated Show resolved Hide resolved
pages/understanding-json-schema/introduction.md Outdated Show resolved Hide resolved
pages/understanding-json-schema/introduction.md Outdated Show resolved Hide resolved
@benjagm
Copy link
Collaborator

benjagm commented Dec 27, 2024

How this new page differs from https://json-schema.org/overview/what-is-jsonschema

Why we need a new one?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[📝 Docs]: Create a standalone introductory guide to JSON Schema
4 participants