fix(docs): Add document references to all currently specified documents (#273)

* fix(docs): Validation of docs generation in CI

* fix(docs): remove test code from docs earthfile

* fix(docs): regenerate image with latest stable d2

* fix(docs): All signed docs now have cross doc references

* regen images

Author: stevenj

docs/src/architecture/08_concepts/signed_doc/doc_relationships.d2

@@ -21,16 +21,6 @@ copyright: |~md
 | Modified | 2025-04-09 |
 | Authors | Alex Pozhylenkov <[email protected]> |
 | | Steven Johnson <[email protected]> |
-
-### Changelog
-
-#### 0.01 (2025-04-04)
-
-* First Published Version
-
-#### 0.02 (2025-04-09)
-
-* Add version control changelogs to the specification.
 ~|  {near: bottom-right}
 
 "Brand Parameters": {
@@ -50,9 +40,11 @@ copyright: |~md
   "type [0]": 5ef32d5d-f240-462c-a7a4-ba4af221fa23
   "id": UUIDv7
   "ver": UUIDv7
+  "brand_id": Brand Parameters
 
 }
 
+"Campaign Parameters"."brand_id"->"Brand Parameters"
 
 
 "Category Parameters": {
@@ -61,9 +53,11 @@ copyright: |~md
   "type [0]": 818938c3-3139-4daa-afe6-974c78488e95
   "id": UUIDv7
   "ver": UUIDv7
+  "campaign_id": Campaign Parameters
 
 }
 
+"Category Parameters"."campaign_id"->"Campaign Parameters"
 
 
 "Comment Moderation Action": {
@@ -74,9 +68,11 @@ copyright: |~md
   "type [2]": a5d232b8-5e03-4117-9afd-be32b878fcdd
   "id": UUIDv7
   "ver": UUIDv7
+  "ref": Proposal Comment
 
 }
 
+"Comment Moderation Action"."ref"->"Proposal Comment"
 
 
 "Election Parameters": {
@@ -85,9 +81,15 @@ copyright: |~md
   "type [0]": 788ff4c6-d65a-451f-bb33-575fe056b411
   "id": UUIDv7
   "ver": UUIDv7
+  "brand_id": Brand Parameters
+  "campaign_id": Campaign Parameters
+  "category_id": Category Parameters
 
 }
 
+"Election Parameters"."brand_id"->"Brand Parameters"
+"Election Parameters"."campaign_id"->"Campaign Parameters"
+"Election Parameters"."category_id"->"Category Parameters"
 
 
 "Proposal": {
@@ -98,11 +100,15 @@ copyright: |~md
   "ver": UUIDv7
   "template": Proposal Template
   "collaborators": Collaborators Reference List
+  "brand_id": Brand Parameters (Optional)
+  "campaign_id": Campaign Parameters (Optional)
   "category_id": Category Parameters (Optional)
 
 }
 
 "Proposal"."template"->"Proposal Template"
+"Proposal"."brand_id"->"Brand Parameters": Optional
+"Proposal"."campaign_id"->"Campaign Parameters": Optional
 "Proposal"."category_id"->"Category Parameters": Optional
 
 
@@ -117,13 +123,17 @@ copyright: |~md
   "template": Proposal Comment Template
   "reply": Proposal Comment (Optional)
   "section": Section Reference
+  "brand_id": Brand Parameters (Optional)
+  "campaign_id": Campaign Parameters (Optional)
   "category_id": Category Parameters (Optional)
 
 }
 
 "Proposal Comment"."ref"->"Proposal"
 "Proposal Comment"."template"->"Proposal Comment Template"
 "Proposal Comment"."reply"->"Proposal Comment": <reply> Optional
+"Proposal Comment"."brand_id"->"Brand Parameters": Optional
+"Proposal Comment"."campaign_id"->"Campaign Parameters": Optional
 "Proposal Comment"."category_id"->"Category Parameters": Optional
 
 
@@ -152,11 +162,15 @@ copyright: |~md
   "id": UUIDv7
   "ver": UUIDv7
   "template": Proposal Comment Meta Template (Optional)
+  "brand_id": Brand Parameters (Optional)
+  "campaign_id": Campaign Parameters (Optional)
   "category_id": Category Parameters (Optional)
 
 }
 
 "Proposal Comment Template"."template"->"Proposal Comment Meta Template": Optional
+"Proposal Comment Template"."brand_id"->"Brand Parameters": Optional
+"Proposal Comment Template"."campaign_id"->"Campaign Parameters": Optional
 "Proposal Comment Template"."category_id"->"Category Parameters": Optional
 
 
@@ -183,9 +197,11 @@ copyright: |~md
   "type [2]": a5d232b8-5e03-4117-9afd-be32b878fcdd
   "id": UUIDv7
   "ver": UUIDv7
+  "ref": Proposal
 
 }
 
+"Proposal Moderation Action"."ref"->"Proposal"
 
 
 "Proposal Submission Action": {
@@ -213,9 +229,13 @@ copyright: |~md
   "id": UUIDv7
   "ver": UUIDv7
   "template": Proposal Meta Template (Optional)
+  "brand_id": Brand Parameters (Optional)
+  "campaign_id": Campaign Parameters (Optional)
   "category_id": Category Parameters (Optional)
 
 }
 
 "Proposal Template"."template"->"Proposal Meta Template": Optional
+"Proposal Template"."brand_id"->"Brand Parameters": Optional
+"Proposal Template"."campaign_id"->"Campaign Parameters": Optional
 "Proposal Template"."category_id"->"Category Parameters": Optional

docs/src/architecture/08_concepts/signed_doc/doc_relationships.svg

@@ -2,7 +2,7 @@
 
 ## Description
 
-TODO
+Parameters which define this brand within the system.
 
 ```d2 layout="elk"
 "Brand Parameters": {
@@ -36,7 +36,7 @@ TODO
 
 ## Metadata
 
-### `type`
+### [`type`](../metadata.md#type)
 <!-- markdownlint-disable MD033 -->
 | Parameter | Value |
 | --- | --- |
@@ -50,7 +50,7 @@ The document TYPE.
 
 **MUST** be a known document type.
 
-### `id`
+### [`id`](../metadata.md#id)
 <!-- markdownlint-disable MD033 -->
 | Parameter | Value |
 | --- | --- |
@@ -66,7 +66,7 @@ timestamp of when the document was created.
 IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with
 [`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist.
 
-### `ver`
+### [`ver`](../metadata.md#ver)
 <!-- markdownlint-disable MD033 -->
 | Parameter | Value |
 | --- | --- |

docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md

@@ -2,7 +2,7 @@
 
 ## Description
 
-TODO
+Parameters which define a Campaign within a Brand in the system.
 
 ```d2 layout="elk"
 "Campaign Parameters": {
@@ -11,8 +11,11 @@ TODO
   "type [0]": 5ef32d5d-f240-462c-a7a4-ba4af221fa23
   "id": UUIDv7
   "ver": UUIDv7
+  "brand_id": Brand Parameters
 
 }
+
+"Campaign Parameters"."brand_id"->"Brand Parameters"
 ```
 
 ### Validation
@@ -36,7 +39,7 @@ TODO
 
 ## Metadata
 
-### `type`
+### [`type`](../metadata.md#type)
 <!-- markdownlint-disable MD033 -->
 | Parameter | Value |
 | --- | --- |
@@ -50,7 +53,7 @@ The document TYPE.
 
 **MUST** be a known document type.
 
-### `id`
+### [`id`](../metadata.md#id)
 <!-- markdownlint-disable MD033 -->
 | Parameter | Value |
 | --- | --- |
@@ -66,7 +69,7 @@ timestamp of when the document was created.
 IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with
 [`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist.
 
-### `ver`
+### [`ver`](../metadata.md#ver)
 <!-- markdownlint-disable MD033 -->
 | Parameter | Value |
 | --- | --- |
@@ -80,6 +83,28 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]
 
 The document version must always be >= the document ID.
 
+### [`brand_id`](../metadata.md#brand_id)
+<!-- markdownlint-disable MD033 -->
+| Parameter | Value |
+| --- | --- |
+| Required | yes |
+| Format | [Document Reference](../metadata.md#document-reference) |
+| Valid References | [Brand Parameters](brand_parameters.md) |
+| Exclusive | [`campaign_id`](../metadata.md#campaign_id) |
+|  | [`category_id`](../metadata.md#category_id) |
+<!-- markdownlint-enable MD033 -->
+A reference to the Brand Parameters Document this document lies under.
+
+#### Validation
+
+In addition to the validation performed for [Document Reference](../metadata.md#document-reference) type fields:
+
+* Any linked referenced document that includes a [`brand_id`](../metadata.md#brand_id) must match the
+[`brand_id`](../metadata.md#brand_id) of the referencing document.
+* MUST NOT be present in any document that contains
+[`campaign_id`](../metadata.md#campaign_id)
+and [`category_id`](../metadata.md#category_id) metadata.
+
 ## Payload
 
 TODO

docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md

@@ -2,7 +2,7 @@
 
 ## Description
 
-TODO
+Parameters which define a Category withing a Campaign under a Brand in the system.
 
 ```d2 layout="elk"
 "Category Parameters": {
@@ -11,8 +11,11 @@ TODO
   "type [0]": 818938c3-3139-4daa-afe6-974c78488e95
   "id": UUIDv7
   "ver": UUIDv7
+  "campaign_id": Campaign Parameters
 
 }
+
+"Category Parameters"."campaign_id"->"Campaign Parameters"
 ```
 
 ### Validation
@@ -36,7 +39,7 @@ TODO
 
 ## Metadata
 
-### `type`
+### [`type`](../metadata.md#type)
 <!-- markdownlint-disable MD033 -->
 | Parameter | Value |
 | --- | --- |
@@ -50,7 +53,7 @@ The document TYPE.
 
 **MUST** be a known document type.
 
-### `id`
+### [`id`](../metadata.md#id)
 <!-- markdownlint-disable MD033 -->
 | Parameter | Value |
 | --- | --- |
@@ -66,7 +69,7 @@ timestamp of when the document was created.
 IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with
 [`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist.
 
-### `ver`
+### [`ver`](../metadata.md#ver)
 <!-- markdownlint-disable MD033 -->
 | Parameter | Value |
 | --- | --- |
@@ -80,6 +83,28 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]
 
 The document version must always be >= the document ID.
 
+### [`campaign_id`](../metadata.md#campaign_id)
+<!-- markdownlint-disable MD033 -->
+| Parameter | Value |
+| --- | --- |
+| Required | yes |
+| Format | [Document Reference](../metadata.md#document-reference) |
+| Valid References | [Campaign Parameters](campaign_parameters.md) |
+| Exclusive | [`brand_id`](../metadata.md#brand_id) |
+|  | [`category_id`](../metadata.md#category_id) |
+<!-- markdownlint-enable MD033 -->
+A reference to the Campaign Parameters Document this document lies under.
+
+#### Validation
+
+In addition to the validation performed for [Document Reference](../metadata.md#document-reference) type fields:
+
+* Any linked referenced document that includes a [`campaign_id`](../metadata.md#campaign_id) must match the
+[`campaign_id`](../metadata.md#campaign_id) of the referencing document.
+* MUST NOT be present in any document that contains
+[`brand_id`](../metadata.md#brand_id)
+and [`category_id`](../metadata.md#category_id) metadata.
+
 ## Payload
 
 TODO