chore(docs): update spec (#101)

Author: strantalis

.gitignore

@@ -21,11 +21,8 @@ yarn-error.log*
 node_modules
 
 # Ignore Remote Content
-/docs/spec/nanotdf/manifest.md
-/docs/spec/tdf/KeyAccessObject.md
-/docs/spec/tdf/Manifest.md
-/docs/spec/tdf/PolicyObject.md
-/docs/spec/tdf/AttributeObject.md
+/docs/spec/index.md
+/docs/spec/**/*.md
 /docs/components/cli/
 /docs/getting-started/configuration.md
 
@@ -34,4 +31,4 @@ node_modules
 # Ignore all downloaded packages and files in vale-styles
 .github/vale-styles/*
 # Except for the config directory where we keep the vocab
-!.github/vale-styles/config/
+!.github/vale-styles/config/

docs/components/key_access.md

@@ -35,8 +35,8 @@ KAS offers the following RPC methods:
 <img src="/img/kas_tdf_flow.svg" alt="KAS TDF Rewrap"/>
 
 1. The client extracts two pieces of information from the TDF:
-   1. [Key Access Object (KAO)](/spec/tdf/kao): This contains the wrapped key and the policy binding.
-   2. The [Policy](/spec/tdf/policy) from the manifest.
+   1. [Key Access Object (KAO)](/spec/schema/opentdf/key_access_object): This contains the wrapped key and the policy binding.
+   2. The [Policy](/spec/schema/opentdf/policy) from the manifest.
 
 2. The client generates an ephemeral asymmetric key pair, used to wrap the KAO content (such as an AES encryption key that can access the TDF payload) from KAS.
 
@@ -84,7 +84,7 @@ At this point, the client is ready to make the rewrap request. The following is
 
 NanoTDF leverages the same KAS Rewrap Endpoint but the request body differs slightly from a TDF Rewrap call. 
 
-1. The client extracts the NanoTDF [Header](/spec/nanotdf/manifest#331-header) and from that Header extracts the KAS URL.
+1. The client extracts the NanoTDF [Header](/spec/schema/nanotdf#331-header) and from that Header extracts the KAS URL.
 
 2. The client generates an ephemeral asymmetric key pair, used to wrap the shared secret originally generated on NanoTDF creation.
 
@@ -129,8 +129,8 @@ NanoTDF leverages the same KAS Rewrap Endpoint but the request body differs slig
     }
     ```
 
-5. KAS extracts the encrypted policy in the NanoTDF [Header](/spec/nanotdf/manifest#331-header) and verifies the policy binding. 
+1. KAS extracts the encrypted policy in the NanoTDF [Header](/spec/schema/nanotdf#331-header) and verifies the policy binding. 
   - If ECDSA Binding is enabled KAS will verify the use ECDSA to verify the signature otherwise it defaults to comparing the `GMAC`
 
-6. If the policy is valid and untampered, KAS calls the [Authorization Service](./authorization) to confirm whether the entity is allowed access to the NanoTDF. If authorized, KAS generates a new shared key with the clients ephemeral public key and uses `AES-GCM` to encrypt the shared secret used to encrypt the NanoTDF payload.
+2. If the policy is valid and untampered, KAS calls the [Authorization Service](./authorization) to confirm whether the entity is allowed access to the NanoTDF. If authorized, KAS generates a new shared key with the clients ephemeral public key and uses `AES-GCM` to encrypt the shared secret used to encrypt the NanoTDF payload.
 

docs/introduction.mdx

@@ -2,9 +2,9 @@
 sidebar_position: 1
 ---
 
-import React from 'react';
-import Callout from '@site/src/components/Callout';
-import Cards from '@site/src/components/Cards';
+import React from "react";
+import Callout from "@site/src/components/Callout";
+import Cards from "@site/src/components/Cards";
 
 # Welcome to OpenTDF Docs
 
@@ -13,39 +13,39 @@ Find all the information you need to get started with OpenTDF.
 <Callout
   title="Quick Start"
   callToAction={{
-    label: 'Learn more',
-    link: '/getting-started',
+    label: "Learn more",
+    link: "/getting-started",
   }}
 >
-  This guide will walk you through setting up a new OpenTDF platform locally and walk you through
-  some of the basic concepts within the OpenTDF platform.
+  This guide will walk you through setting up a new OpenTDF platform locally and
+  walk you through some of the basic concepts within the OpenTDF platform.
 </Callout>
 
-<Cards 
+<Cards
   height={300}
   columns={3}
   items={[
     {
-      name: 'TDF',
+      name: "TDF",
       description: `
         The Trust Data Format (TDF) is an open standard that enables the cryptographic binding ofattribute-based
          access control (ABAC) policy to a data object so that the policy travels with the data.`,
-      url: '/category/base-tdf',
+      url: "/spec/schema/opentdf",
     },
     {
-      name: 'Policy',
+      name: "Policy",
       description: `The OpenTDF Policy engine enables creation, enforcement, and subscription to policies. By
       using attribute-based access control (ABAC) policies, the OpenTDF Policy engine can enforce flexible,
       fine-grained access control based on entity entitlements.`,
-      url: '/components/policy',
+      url: "/components/policy",
     },
     {
-      name: 'Authorization',
+      name: "Authorization",
       description: `The OpenTDF Authorization service enables policy driven, access based decisions using
       attribute-based access control (ABAC) based on entity entitlements. These decisions are used to enforce
       both data privacy and application security, ensuring consistent policy enforcement across all policy
       enforcement points.`,
-      url: '/components/authorization',
+      url: "/components/authorization",
     },
   ]}
 />
@@ -58,14 +58,16 @@ Find all the information you need to get started with OpenTDF.
   columns={2}
   items={[
     {
-      name: 'SDK',
-      description: 'Learn about the Trust Data Format (TDF) and how it enables the cryptographic binding of attribute-based access control (ABAC) policy to a data object.',
-      url: '/category/sdk',
+      name: "SDK",
+      description:
+        "Learn about the Trust Data Format (TDF) and how it enables the cryptographic binding of attribute-based access control (ABAC) policy to a data object.",
+      url: "/category/sdk",
     },
     {
-      name: 'CLI',
-      description: 'Learn about the OpenTDF CLI tool (otdfctl) and how it can be used to manage the OpenTDF platform.',
-      url: '/components/cli',
+      name: "CLI",
+      description:
+        "Learn about the OpenTDF CLI tool (otdfctl) and how it can be used to manage the OpenTDF platform.",
+      url: "/components/cli",
     },
   ]}
 />

docs/spec/NanoTDF/_category_.json

@@ -2,7 +2,7 @@
   "label": "Specification",
   "position": 10,
   "link": {
-    "type": "generated-index",
-    "description": "OpenTDF includes specifications for multiple variations of the Trusted Data Format (TDF) including the JSON encoded Base TDF data format and the NanoTDF binary file format. These specifications are intended to be used as a reference for developers who are implementing TDF support in their applications."
+    "type": "doc",
+    "id": "spec/index"
   }
-}
+}

docs/spec/_category_.json

@@ -0,0 +1,7 @@
+{
+  "label": "Concepts",
+  "position": 1,
+  "link": {
+    "type": "generated-index"
+  }
+}

docs/spec/concepts/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Protocol",
+  "position": 1
+}

docs/spec/protocol/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Schema",
+  "position": 2,
+  "link": {
+    "type": "doc",
+    "id": "spec/schema/index"
+  }
+}

docs/spec/schema/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "OpenTDF",
+  "position": 1,
+  "link": {
+    "type": "doc",
+    "id": "spec/schema/opentdf/index"
+  }
+}