uncefact / spec-untp

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

Trim the spec sections #62

Closed nissimsan closed 2 months ago

nissimsan commented 2 months ago

hi team - something I want to discuss today. i think we have too many headings under https://uncefact.github.io/spec-untp/docs/specification/. It's not so much that I think some need to be merged but rather I think some are genuinely testable normative specifications and some are really more like informative best practices. So I'm gonna suggest that the first 7 headings (architecture down to verifiable credentials) can be normative specs and the last 7 (data carriers to ESG rules) can be informative best practices. Maybe over time some really solid practices will emerge that trigger us to lift some some of the practices to become specifications. But lets not force that now. Also makes the implementation scope simpler and more understandable.

I support trimming the headlines. Some, I think, can be bundled into, say, a “Design Patterns” section (with mass balance, anti-counterfeiting, confidentiality…)

onthebreeze commented 2 months ago

I'd like to propose a minor re-structure of the current site architecture from what you see now at https://uncefact.github.io/spec-untp/docs/about/ - which looks like this:

From This

About the UNTP

To this

Changes are in bold text

About the UNTP

onthebreeze commented 2 months ago

I'll prepare a PR with this re-structure. Please add your objections or suggestions to this ticket.

zachzeus commented 2 months ago

Do we want to add 'Implementation Tools' to the implementation guidance section? Otherwise looks good.

onthebreeze commented 2 months ago

closed with pr https://github.com/uncefact/spec-untp/pull/85