Skip to content

Commit

Permalink
Copy over diagrams to v1 dir (#1092)
Browse files Browse the repository at this point in the history
* fix(spec): revert vector insertion

* fix(spec): insertion of vector examples

* fix(spec): update spec file

* fix(spec): add appendix

* fix(spec): update to sync replacers

* fix(spec): add ability to specify controller prop in key patches

* fix(spec): typo and wording fixes

* fix(spec): fix typo

* fix(spec): add v1.0.0 static spec file

* fix(spec): copying over assests to v1.0.0

* fix(spec): copy diagrams

* fix(spec): pathing
  • Loading branch information
csuwildcat committed Mar 12, 2021
1 parent 9ab3ce6 commit 51531fe
Show file tree
Hide file tree
Showing 18 changed files with 53 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/spec/file-structures.md
Expand Up @@ -3,7 +3,7 @@

The protocol defines the following three file structures, which house DID operation data and are designed to support key functionality to enable light node configurations, minimize permanently retained data, and ensure performant resolution of DIDs.

<img src="../diagrams/file-topology.svg" style="display: block; margin: 0 auto; padding: 2em 0; width: 100%; max-width: 620px;" />
<img src="/diagrams/file-topology.svg" style="display: block; margin: 0 auto; padding: 2em 0; width: 100%; max-width: 620px;" />

### Core Index File

Expand Down
2 changes: 1 addition & 1 deletion docs/spec/topology.md
Expand Up @@ -6,4 +6,4 @@ The figure below illustrates the three primary components of a Sidetree-based DI
2. The Sidetree nodes themselves, which interact with the anchoring system to anchor operations, fetch and replicate data from the CAS network, and process operations in accordance with the protocol deterministic ruleset.
3. An integrated Content-Addressable Storage (CAS) network layer Sidetree nodes use to distribute and replicate DID operation files.

<img src="../diagrams/sidetree-system.svg" style="display: block; margin: 0 auto; padding: 1em 0; width: 100%; max-width: 620px;" />
<img src="/diagrams/sidetree-system.svg" style="display: block; margin: 0 auto; padding: 1em 0; width: 100%; max-width: 620px;" />
2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -51,7 +51,7 @@
"jasmine-reporters": "2.3.2",
"jasmine-spec-reporter": "4.2.1",
"nyc": "15.0.1",
"spec-up": "0.10.1",
"spec-up": "0.10.2",
"ts-node": "8.3.0",
"tslint": "5.11.0",
"tslint-config-standard": "8.0.1",
Expand Down
Binary file added www/spec/diagrams/architecture.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added www/spec/diagrams/architecture.vsdx
Binary file not shown.
15 changes: 15 additions & 0 deletions www/spec/diagrams/file-topology.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added www/spec/diagrams/operationChaining.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added www/spec/diagrams/operationChaining.vsdx
Binary file not shown.
9 changes: 9 additions & 0 deletions www/spec/diagrams/sidetree-system.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added www/spec/diagrams/versioning.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added www/spec/v1.0.0/diagrams/architecture.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added www/spec/v1.0.0/diagrams/architecture.vsdx
Binary file not shown.
15 changes: 15 additions & 0 deletions www/spec/v1.0.0/diagrams/file-topology.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added www/spec/v1.0.0/diagrams/operationChaining.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added www/spec/v1.0.0/diagrams/operationChaining.vsdx
Binary file not shown.
9 changes: 9 additions & 0 deletions www/spec/v1.0.0/diagrams/sidetree-system.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added www/spec/v1.0.0/diagrams/versioning.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions www/spec/v1.0.0/index.html
Expand Up @@ -377,10 +377,10 @@ <h2 id="network-topology"><a class="toc-anchor" href="#network-topology" >§</a>
<li>The Sidetree nodes themselves, which interact with the anchoring system to anchor operations, fetch and replicate data from the CAS network, and process operations in accordance with the protocol deterministic ruleset.</li>
<li>An integrated Content-Addressable Storage (CAS) network layer Sidetree nodes use to distribute and replicate DID operation files.</li>
</ol>
<img src="../diagrams/sidetree-system.svg" style="display: block; margin: 0 auto; padding: 1em 0; width: 100%; max-width: 620px;" />
<img src="/diagrams/sidetree-system.svg" style="display: block; margin: 0 auto; padding: 1em 0; width: 100%; max-width: 620px;" />
<h2 id="file-structures"><a class="toc-anchor" href="#file-structures" >§</a> File Structures</h2>
<p>The protocol defines the following three file structures, which house DID operation data and are designed to support key functionality to enable light node configurations, minimize permanently retained data, and ensure performant resolution of DIDs.</p>
<img src="../diagrams/file-topology.svg" style="display: block; margin: 0 auto; padding: 2em 0; width: 100%; max-width: 620px;" />
<img src="/diagrams/file-topology.svg" style="display: block; margin: 0 auto; padding: 2em 0; width: 100%; max-width: 620px;" />
<h3 id="core-index-file"><a class="toc-anchor" href="#core-index-file" >§</a> Core Index File</h3>
<p>Core Index Files contain <a href="#create" >Create</a>, <a href="#recover" >Recover</a>, and <a href="#deactivate" >Deactivate</a> operation values, as well as a CAS URI for the related <a href="#provisional-index-file" >Provisional Index File</a> (detailed below). As the name suggests, Core Index Files are anchored to the target anchoring system via embedding a CAS URI in the anchoring system’s transactional history.</p>
<div id="example-1" class="notice example"><a class="notice-link" href="#example-1">EXAMPLE</a><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span>
Expand Down

0 comments on commit 51531fe

Please sign in to comment.