Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split spec.md into sub files to be able to handle the terms and definitions separately #104

Open
wants to merge 4 commits into
base: revised-format
Choose a base branch
from

Conversation

henkvancann
Copy link

Diff-tool comparison of generated specifications: https://henkvancann.github.io/tswg-acdc-specification/ vs https://trustoverip.github.io/tswg-acdc-specification.

Result is the following and is OK (tool: https://editor.mergely.com/):

51d50
< <!-- file name: header.md -->
71d69
< <!-- file name: foreword.md -->
76d73
< <!-- file name: introduction.md -->
88d84
< <!-- file name: doc-features.md -->
93d88
< <!-- file name: doc-features.md -->
103d97
< <!-- file name: doc-features.md -->
108d101
< <!-- file name: doc-features.md -->
111d103
< <!-- file name: doc-features.md -->
114d105
< <!-- file name: terms-and-definitions.md -->
200d190
< <!-- file name: acdc-structure.md -->
351d340
< <!-- file name: acdc-variants.md -->
558d546
< <!-- file name: top-level-acdc-sections.md -->
2368d2355
< <!-- file name: disclosure-mechanisms-and-exploitation-protection.md -->
2393d2379
< <!-- file name: exploitation-protection-mechanisms.md -->
2446d2431
< <!-- file name: issuance-and-presentation-exchange-ipex.md  -->
2451c2436
< <p>This IPEX <a class="term-reference" href="#term:ipex">IPEX</a> protocol leverages important features of ACDCs and ancillary protocols such as CESR [<a path-0="github.com"path-1="trustoverip"path-2="tswg-acdc-specification"href="https://github.com/trustoverip/tswg-acdc-specification" >1</a>], SAIDs [<a path-0="github.com"path-1="trustoverip"path-2="tswg-cesr-specification"href="https://github.com/trustoverip/tswg-cesr-specification" >3</a>], and CESR-Path proofs <a class="term-reference" href="#term:proof-id">Proof-ID</a> as well as Ricardian Contracts [<a path-0="en.wikipedia.org"path-1="wiki"path-2="Ricardian_contract"href="https://en.wikipedia.org/wiki/Ricardian_contract" >43</a>] and Graduated Disclosure (Metadata, Partial, Selective, Full) to enable Contractually Protected Disclosure. Contractually Protected Disclosure includes both Chain-Link Confidential [<a path-0="papers.ssrn.com"path-1="sol3"path-2="papers.cfm"href="https://papers.ssrn.com/sol3/papers.cfm?abstract_id=2045818" >44</a>] and Contingent Disclosure <a class="term-reference" href="#term:acdc">ACDC</a>.</p>
---
> <p>This IPEX <a class="term-reference" href="#term:ipex">IPEX</a> protocol leverages important features of ACDCs and ancillary protocols such as CESR [<a path-0="github.com"path-1="trustoverip"path-2="tswg-acdc-specification"href="https://github.com/trustoverip/tswg-acdc-specification" >1</a>], SAIDs [<a path-0="github.com"path-1="trustoverip"path-2="tswg-cesr-specification"href="https://github.com/trustoverip/tswg-cesr-specification" >3</a>], and CESR-Path proofs <a class="term-reference" href="#term:proof-id">Proof-ID</a> as well as Ricardian Contracts [<a path-0="en.wikipedia.org"path-1="wiki"path-2="Ricardian_contract"href="https://en.wikipedia.org/wiki/Ricardian_contract" >43</a> and Graduated Disclosure (Metadata, Partial, Selective, Full) to enable Contractually Protected Disclosure. Contractually Protected Disclosure includes both Chain-Link Confidential [<a path-0="papers.ssrn.com"path-1="sol3"path-2="papers.cfm"href="https://papers.ssrn.com/sol3/papers.cfm?abstract_id=2045818" >44</a> and Contingent Disclosure <a class="term-reference" href="#term:acdc">ACDC</a>.</p>
2588d2572
< <!-- file name: transaction-event-logs-tels-as-acdc-state-registries.md -->
2930d2913
< <!-- file name: annex.md -->
4027,4028d4009
< <h2 id="bibliography"><a class="toc-anchor" href="#bibliography" >§</a> Bibliography</h2>
< <!-- file name: bibliography.md -->
4308d4288
< <li><a href="#bibliography" >Bibliography</a></li>
4317c4297
<                 <script>window.specConfig = {"title":"Authentic Chained Data Containers (ACDC)","spec_directory":"./spec/","output_path":"./docs","markdown_paths":["header.md","foreword.md","introduction.md","doc-features.md","terms-and-definitions.md","acdc-structure.md","acdc-variants.md","top-level-acdc-sections.md","disclosure-mechanisms-and-exploitation-protection.md","exploitation-protection-mechanisms.md","issuance-and-presentation-exchange-ipex.md","transaction-event-logs-tels-as-acdc-state-registries.md","annex.md","bibliography.md"],"logo":"https://raw.githubusercontent.com/trustoverip/logo-assets/master/logos/ToIP-Logo-Color-SolidDimensional-Horizontal-LightOnDark.svg","logo_link":"https://github.com/trustoverip/tswg-acdc-specification","katex":true,"source":{"host":"github","account":"trustoverip","repo":"tswg-acdc-specification"},"destination":"./docs/"}</script>
---
>                 <script>window.specConfig = {"title":"Authentic Chained Data Containers (ACDC)","spec_directory":"./spec/","output_path":"./docs","markdown_paths":["spec.md"],"logo":"https://raw.githubusercontent.com/trustoverip/logo-assets/master/logos/ToIP-Logo-Color-SolidDimensional-Horizontal-LightOnDark.svg","logo_link":"https://github.com/trustoverip/tswg-acdc-specification","katex":true,"source":{"host":"github","account":"trustoverip","repo":"tswg-acdc-specification"},"destination":"./docs/"}</script>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant