Re: How do you document your JSON-LD context files ?

On Thu, Mar 14, 2024 at 7:06 AM Thomas Francart
<thomas.francart@sparna.fr> wrote:
> Basically, the social aspect of exchanging and documenting context is simply not addressed, and this is frustrating. JSON-LD contexts are not only for machines. Sometimes technical people look at them to use and understand them, we need to carry some documentation information for this.
> How can this be addressed ?

We had discussed a "@comment" keyword in the past, though there were
good reasons a number of people argued against it (it's non-standard,
bloats the markup during runtime, etc.). Some argued that the best
thing to do might be to just use the syntaxes commenting mechanism,
such as YAML-LD using "#". Others noted that using "rdfs:comment"
would be better. Still others noted that the place for commentary is
in the human-readable vocabulary documentation, and if commentary is
needed, it should go in the specification and not the JSON-LD Context.

At present, I believe we just don't have consensus on a SINGLE
approach forward given that there are benefits and drawbacks to each
approach above. No one has been able to convince the community that we
need a single mechanism for commenting in JSON-LD Contexts.

-- manu

-- 
Manu Sporny - https://www.linkedin.com/in/manusporny/
Founder/CEO - Digital Bazaar, Inc.
https://www.digitalbazaar.com/

Received on Thursday, 14 March 2024 12:10:30 UTC