-
-
Notifications
You must be signed in to change notification settings - Fork 195
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
base: main
Are you sure you want to change the base?
Conversation
@valeriahhdez please review this PR |
Hi @techmannih, Yes, I'll review it. |
@techmannih it seems like ci checks are failing pls. fix them |
built with Refined Cloudflare Pages Action⚡ Cloudflare Pages Deployment
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
@DhairyaMajmudar done
|
There was a problem hiding this 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!
How this new page differs from https://json-schema.org/overview/what-is-jsonschema Why we need a new one? |
Issue Number: