w3c / vc-extensions

Verifiable Credential Extensions
https://w3c.github.io/vc-extensions/
Other
12 stars 14 forks source link

Add an example JSON file the "how to register" section #3

Closed jandrieu closed 1 year ago

jandrieu commented 1 year ago

Seems to me that parsing YAML is a fairly high barrier. An example would help.

OR13 commented 1 year ago

Is this still an issue? I just added to new entries and I found the current instructions intuitive.

jandrieu commented 1 year ago

Seeing as how there is not a JSON example to the section on 1.1 Adding a Specification Entry, yes, it is still an issue.

Simply pointing to a YAML file that defines a JSON schema is obfuscating and nearly useless.

Putting a JSON example in that section is a modest ask and would immediately make it clear what is needed to add an entry.

OR13 commented 1 year ago

Ahh, I didn't realize this was about the respec.

Seems very easy to fix, given there are examples in the PR template and readme.

And several merged PRs at this point.

@jandrieu would you be willing to do a PR?

OR13 commented 1 year ago

@jandrieu can you please review https://github.com/w3c/vc-specs-dir/pull/10

Let me know if you want more.

jandrieu commented 1 year ago

Reviewed. Looks good.

msporny commented 1 year ago

PR #10 has been merged, closing.