json-schema-org.github.io icon indicating copy to clipboard operation
json-schema-org.github.io copied to clipboard

Include mission statement on the home page

Open Relequestual opened this issue 3 years ago • 5 comments

Resolves https://github.com/json-schema-org/community/issues/97

Relequestual avatar Dec 08 '21 12:12 Relequestual

Deploy Preview for condescending-hopper-c3ed30 ready!

Name Link
Latest commit 7a877ff0e0843c5873c23507c2d719e7b38f408b
Latest deploy log https://app.netlify.com/sites/condescending-hopper-c3ed30/deploys/6363cfdc1f5522000946e826
Deploy Preview https://deploy-preview-423--condescending-hopper-c3ed30.netlify.app/
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify[bot] avatar Dec 08 '21 12:12 netlify[bot]

This strikes me as a bit wordy. It doesn't help me understand if I'm the target audience or not.

declarative domain specific grammar and syntax

This is too many adjectives for me. Describing the technical basis of JSON Schema is a good idea, but they can be split out into a separate sentence that defines the lingo. For example

JSON Schema is declarative, where you make assertions about what JSON is expected to look like.

"domain specific" is redundant (we say it's only for JSON, that's it's "domain"). And "grammar and syntax" I don't think is accurate (the grammar is JSON, we don't define our own grammar, we define an existing grammar's semantics).

JSON Schema enables the confident and reliable use of the JSON data format.

This doesn't help me understand if I'm the target audience or not. If we absolutely have to, describe the impact on actual developers, like "Developers use JSON Schema as a reliable alternative to hard-coding validation rules in code."

awwright avatar Mar 10 '22 19:03 awwright

"domain specific" is redundant (we say it's only for JSON, that's it's "domain")

The domain is JSON validation and annotation, but I agree that "domain specific" is not useful for anyone who isn't familiar with the concept of a domain specific language (DSL). Would this be better?

JSON Schema is a declarative language that allows you to annotate and validate JSON documents.

jdesrosiers avatar Mar 14 '22 02:03 jdesrosiers

JSON Schema is a declarative language that allows you to annotate and validate JSON documents.

💯

awwright avatar Mar 14 '22 02:03 awwright

The only reason I would prefer "vocabulary" or some similar term over "language" is because "language" to me includes both the grammar/syntax and the vocabulary. JSON Schema does not define any syntax, only the vocabulary.

But it also seems to me "language" is a more accessible term than "vocabulary", here.

awwright avatar Mar 14 '22 02:03 awwright

While the first part of the change makes senes, I'm not sure the "mission" part does right now.

I'll move the first part of this PR to a new PR, and close this PR, in favour of further investigation on vision and planning with a deliverable being a charter and mission statement.

Relequestual avatar Nov 03 '22 14:11 Relequestual

Closed in favour of https://github.com/json-schema-org/json-schema-org.github.io/pull/487

Relequestual avatar Nov 03 '22 14:11 Relequestual