search

uncefact / spec-untp

UN Transparency Protocol
https://uncefact.github.io/spec-untp/
GNU General Public License v3.0
10 stars 9 forks source link

Include the actual YAML for the DPP schema on the spec page #5

Closed nissimsan closed 5 months ago

nissimsan commented 5 months ago

Linking to https://jargon.sh/user/unece/ConformityCredential/v/working/artefacts/readme/render is difficult to interpret

nissimsan commented 5 months ago

Tagging @colugo ^

colugo commented 5 months ago

Hey @nissimsan Are you saying it's hard to interpret the content of that page, or that it's difficult to link to anchors on that page?

Or something else ;)

colugo commented 5 months ago

Although now having read the issue title, I understand a little more ;)

I can manually add the YAML (although JSON would seem more natural, no?) now, and can look into having it automatically updated in the future.

colugo commented 5 months ago

I've manually added the schema as YAML. It will not automatically update, and so runs the risk of becoming stale. Still, take a look and see if it addresses your concerns, and I can look into having Jargon auto-populate the up-to-date schema as part of the standard readme functionality.

https://jargon.sh/user/unece/ConformityCredential/v/working/artefacts/readme/render#conformityattestation-schema

nissimsan commented 5 months ago

Great, @colugo, thanks a bunch! That's precisely what I was aiming for. This makes it much more tangible.

Ultimately we probably want to include that YAML on https://uncefact.github.io/spec-untp/docs/specification/DigitalProductPassport at some point. Maybe. But that's for later - let's focus on the data modelling for now.

Cheers!