trustoverip / tswg-acdc-specification

Authentic Chained Data Containers (ACDC)
https://trustoverip.github.io/tswg-acdc-specification/
Other
10 stars 7 forks source link

list or diagram all spec dependencies #77

Closed edeykholt closed 5 months ago

edeykholt commented 7 months ago

This issue isn't specific to ACDC, but this is not a bad place to track it. A new reader to the ToIP Specs can easily get lost in all the dependencies across the specifications, including some "mini-spec" sections that are more general purpose and used broader than for the spec it is contained in.

Unclear where this overview of specs and their dependencies is best placed.

As a start, the attached image was generated from Mermaid, with the code below.

An alternate presentation would be to list the dependencies in a table, e.g. | ToIP Layer | Specification | Specification Dependencies |

image

graph TB Layer4-.->Layer3 Layer3-.->Layer2 Layer2-.->Layer1

subgraph Layer1[ToIP Layer 1]
    KERI1[KERI]
    CESR
    oobi[KERI:AID OOBI]
end
subgraph Layer2[ToIP Layer 2]
    TSP
end

subgraph Layer3[ToIP Layer 3]
    ACDC
    ACDC-.->KERI1
    ACDC-.->CESR
    ipex[ACDC IPEX]
end

subgraph Layer4[ToIP Layer 4]
    didwebs[did:webs]
    trp[Trust Registry Protocol]
    ptel[KERI pTEL]-.->KERI1
end

Questions:

2byrds commented 7 months ago

This issue isn't specific to ACDC, but this is not a bad place to track it. A new reader to the ToIP Specs can easily get lost in all the dependencies across the specifications, including some "mini-spec" sections that are more general purpose and used broader than for the spec it is contained in.

Unclear where this overview of specs and their dependencies is best placed.

As a start, the attached image was generated from Mermaid, with the code below.

An alternate presentation would be to list the dependencies in a table, e.g. | ToIP Layer | Specification | Specification Dependencies |

image

graph TB Layer4-.->Layer3 Layer3-.->Layer2 Layer2-.->Layer1

subgraph Layer1[ToIP Layer 1]
    KERI1[KERI]
    CESR
    oobi[KERI:AID OOBI]
end
subgraph Layer2[ToIP Layer 2]
    TSP
end

subgraph Layer3[ToIP Layer 3]
    ACDC
    ACDC-.->KERI1
    ACDC-.->CESR
    ipex[ACDC IPEX]
end

subgraph Layer4[ToIP Layer 4]
    didwebs[did:webs]
    trp[Trust Registry Protocol]
    ptel[KERI pTEL]-.->KERI1
end

Questions:

  • Is the ToIP Reference Architecture a specification, since it includes some normative language?
  • What specs or sections might be missing?

This is great @edeykholt ! And I would like to continue to build more diagrams and have them reference each other, etc. (for instance the diagram from did:webs for choosing KERI features). Eventually I'd like this to help document the ecosystem, what is avaialble, what is coming, what depends on what, etc.

2byrds commented 6 months ago

Good discussion about this in the did:webs TF meeting. We pushed most pieces into layer 1 of the ToIP stack https://trustoverip.org/toip-model/

edeykholt commented 6 months ago

In this next update, I've removed the ToIP Layers, since they are not part of the individual specifications, and might be more high-level conceptual or marketing.

graph TB KERI-.->CESR CESR ACDC ACDC-.->KERI ACDC-.->CESR ipex[ACDC IPEX]-.->ACDC didwebs[did:webs]-.->KERI tel[ACDC TEL]-.->ACDC trp[Trust Registry Protocol] TSP-.->KERI TSP-.->CESR

edeykholt commented 6 months ago

https://mermaid.live/view#pako:eNpdkMEKgzAMhl-l5Kx7AA-DzXkY20HUw8B66Gw2C2qlpmwie_e1OBCXS36-_PlJO0OtJUIETyOGhhVH3jNXlyQ7h7twHyd5tpBVHeJTvCrv8u4tWd1qwHfpMTunya3ywzVAKvnC-1i6HnlRbdMI22W1SK5_m2SGsjB2JJbhU41kJpYaTbrWbbU4ijzdpv2APw0C6NB0Qkn38tmPOVCDHXKInJT4ELYlDrz_OKuwpPOpryEiYzEAO0hBeFLC_Vm3wM8X5-xg8w

edeykholt commented 6 months ago

image

2byrds commented 6 months ago

I like that update @edeykholt and aligns much better with my KERI Ecosystem dependency spreadsheet!

pfeairheller commented 5 months ago

@edeykholt to write a future ToIP Blog or Medium article on this topic.