w3c / w3c/vc-render-method

Editorial comments on (JSON) cards

Open
#61 1 comment 0 reactions 1 assignee View on GitHub

@dmitrizagidulin is already working on this.

Since Aug 25, 2026.

pr exists
Dominant language
HTML
Stars
9
Forks
8
Avg merge
14d 42m
Merged PRs (30d)
2

Description

(My apologies for not having raised these earlier.)

  • The text says, at the beginning of §2.2.1.1 "The template SHOULD be validated against this schema before processing.", referring to a set of JSON terms. Then it says, after the table "The following JSON Schema implements the template structure rules defined above". Ie, the term "schema" is used first as a loose concept, and then, more formally, as a specific thing, namely JSON Schema.

    Also, the table is meant to define a JSON (as opposed to JSON-LD) structure, but the term "property" is used in the table (in pure JSON the official term for a property is name, and instead of "structure" the term object is used). Note also that the editorial style is also following the same approach (table with blue heading color) as usually used for JSON-LD terms in our specs.

    I believe all these are a source of confusion. It would be better to use a different style for the template object definition, and use the official JSON terminology, not JSON-LD's (which is inherited from RDF).

  • Similar comments are applicable for §2.2.1.2. Additionally, it is again a bit confusing that the two tables (ie, and the aforementioned one) are almost identical, except (understandably) the references to JSON Pointers. I wonder whether it would be possible to use one object definition only (from JSON's point of view there is structurally no difference between a string an a JSON pointer), making it clear that pointers can be used for the template definition.

  • I believe the JSON Schema in Example 1 is informative (all examples are). Following the styles of our specs in general, it may make things cleaner if the schema was pushed into an informative appendix. At present it is easy to believe, at a cursory look, that this schema is normative.

  • The examples in §2.2.1.3 should be put into a separate subsection. The template processing should stand by itself.

  • The text before example 4 does not necessarily coincide with the description (" The template uses JSON pointer strings to reference credential data."). The "only" thing the example shows is that a data URL can be used to provide a template.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.