fix(docs): enhance formatting of ID validation rules in signed document metadata

nathanbogale · nathanbogale · commit 73ae874b0e0d · 2025-11-17T17:09:42.000+03:00
- Improve formatting for ID validation rules across multiple documentation files to enhance readability.
- Ensure consistent presentation of timestamp threshold criteria for better clarity.
- Update the signed_doc.json specification to reflect the new formatting standards.
diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md b/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md
@@ -87,6 +87,7 @@ timestamp of when the document was created.
 #### [`id`](../metadata.md#id) Validation
 
 The document ID validation is performed based on timestamp thresholds:
+
 * If `future_threshold` is configured, the document `id` cannot be too far in the future from the
   current time.
 * If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -220,4 +221,3 @@ of the previous submitted document's version.
 [RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1
 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
-
diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters_form_template.md
@@ -92,10 +92,11 @@ timestamp of when the document was created.
 #### [`id`](../metadata.md#id) Validation
 
 The document ID validation is performed based on timestamp thresholds:
+
 * If `future_threshold` is configured, the document `id` cannot be too far in the future from the
-  current time.
+    current time.
 * If `past_threshold` is configured, the document `id` cannot be too far in the past from the
-  current time.
+    current time.
 
 <!-- markdownlint-disable MD033 -->
 | Parameter | Value |
@@ -161,4 +162,3 @@ Only the original author can update and sign a new version of documents.
 [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12
 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
-
diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md b/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md
@@ -88,6 +88,7 @@ timestamp of when the document was created.
 #### [`id`](../metadata.md#id) Validation
 
 The document ID validation is performed based on timestamp thresholds:
+
 * If `future_threshold` is configured, the document `id` cannot be too far in the future from the
   current time.
 * If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -249,4 +250,3 @@ of the previous submitted document's version.
 [RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1
 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
-
diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters_form_template.md
@@ -92,6 +92,7 @@ timestamp of when the document was created.
 #### [`id`](../metadata.md#id) Validation
 
 The document ID validation is performed based on timestamp thresholds:
+
 * If `future_threshold` is configured, the document `id` cannot be too far in the future from the
   current time.
 * If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -189,4 +190,3 @@ Only the original author can update and sign a new version of documents.
 [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12
 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
-
diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters.md b/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters.md
@@ -88,6 +88,7 @@ timestamp of when the document was created.
 #### [`id`](../metadata.md#id) Validation
 
 The document ID validation is performed based on timestamp thresholds:
+
 * If `future_threshold` is configured, the document `id` cannot be too far in the future from the
   current time.
 * If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -249,4 +250,3 @@ of the previous submitted document's version.
 [RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1
 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
-
diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters_form_template.md
@@ -92,6 +92,7 @@ timestamp of when the document was created.
 #### [`id`](../metadata.md#id) Validation
 
 The document ID validation is performed based on timestamp thresholds:
+
 * If `future_threshold` is configured, the document `id` cannot be too far in the future from the
   current time.
 * If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -189,4 +190,3 @@ Only the original author can update and sign a new version of documents.
 [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12
 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
-
diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md b/docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md
@@ -78,6 +78,7 @@ timestamp of when the document was created.
 #### [`id`](../metadata.md#id) Validation
 
 The document ID validation is performed based on timestamp thresholds:
+
 * If `future_threshold` is configured, the document `id` cannot be too far in the future from the
   current time.
 * If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -182,4 +183,3 @@ Only the original author can update and sign a new version of documents.
 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
 [IPFS-CID]: https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
-
diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md
@@ -89,6 +89,7 @@ timestamp of when the document was created.
 #### [`id`](../metadata.md#id) Validation
 
 The document ID validation is performed based on timestamp thresholds:
+
 * If `future_threshold` is configured, the document `id` cannot be too far in the future from the
   current time.
 * If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -504,4 +505,3 @@ Only the original author can update and sign a new version of documents.
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
 [RFC8949]: https://www.rfc-editor.org/rfc/rfc8949.html
 [RFC8610]: https://www.rfc-editor.org/rfc/rfc8610
-
diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot_checkpoint.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot_checkpoint.md
@@ -111,6 +111,7 @@ timestamp of when the document was created.
 #### [`id`](../metadata.md#id) Validation
 
 The document ID validation is performed based on timestamp thresholds:
+
 * If `future_threshold` is configured, the document `id` cannot be too far in the future from the
   current time.
 * If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -537,4 +538,3 @@ Only the original author can update and sign a new version of documents.
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
 [RFC8949]: https://www.rfc-editor.org/rfc/rfc8949.html
 [RFC8610]: https://www.rfc-editor.org/rfc/rfc8610
-
diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_delegation.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_delegation.md
@@ -148,6 +148,7 @@ timestamp of when the document was created.
 #### [`id`](../metadata.md#id) Validation
 
 The document ID validation is performed based on timestamp thresholds:
+
 * If `future_threshold` is configured, the document `id` cannot be too far in the future from the
   current time.
 * If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -383,4 +384,3 @@ Only the original author can update and sign a new version of documents.
 [IPFS-CID]: https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
 [RFC8259]: https://www.rfc-editor.org/rfc/rfc8259.html
-
diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters.md
@@ -88,6 +88,7 @@ timestamp of when the document was created.
 #### [`id`](../metadata.md#id) Validation
 
 The document ID validation is performed based on timestamp thresholds:
+
 * If `future_threshold` is configured, the document `id` cannot be too far in the future from the
   current time.
 * If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -251,4 +252,3 @@ of the previous submitted document's version.
 [RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1
 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
-
diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters_form_template.md
@@ -92,6 +92,7 @@ timestamp of when the document was created.
 #### [`id`](../metadata.md#id) Validation
 
 The document ID validation is performed based on timestamp thresholds:
+
 * If `future_threshold` is configured, the document `id` cannot be too far in the future from the
   current time.
 * If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -191,4 +192,3 @@ Only the original author can update and sign a new version of documents.
 [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12
 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
-
diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/presentation_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/presentation_template.md
@@ -90,6 +90,7 @@ timestamp of when the document was created.
 #### [`id`](../metadata.md#id) Validation
 
 The document ID validation is performed based on timestamp thresholds:
+
 * If `future_threshold` is configured, the document `id` cannot be too far in the future from the
   current time.
 * If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -277,4 +278,3 @@ Only the original author can update and sign a new version of documents.
 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
 [RFC8259]: https://www.rfc-editor.org/rfc/rfc8259.html
-
diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal.md
@@ -96,6 +96,7 @@ timestamp of when the document was created.
 #### [`id`](../metadata.md#id) Validation
 
 The document ID validation is performed based on timestamp thresholds:
+
 * If `future_threshold` is configured, the document `id` cannot be too far in the future from the
   current time.
 * If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -263,4 +264,3 @@ of the previous submitted document's version.
 [RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1
 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
-
diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment.md
@@ -80,6 +80,7 @@ timestamp of when the document was created.
 #### [`id`](../metadata.md#id) Validation
 
 The document ID validation is performed based on timestamp thresholds:
+
 * If `future_threshold` is configured, the document `id` cannot be too far in the future from the
   current time.
 * If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -302,4 +303,3 @@ Only the original author can update and sign a new version of documents.
 [IPFS-CID]: https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
 [RFC8259]: https://www.rfc-editor.org/rfc/rfc8259.html
-
diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment_form_template.md
@@ -92,6 +92,7 @@ timestamp of when the document was created.
 #### [`id`](../metadata.md#id) Validation
 
 The document ID validation is performed based on timestamp thresholds:
+
 * If `future_threshold` is configured, the document `id` cannot be too far in the future from the
   current time.
 * If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -191,4 +192,3 @@ Only the original author can update and sign a new version of documents.
 [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12
 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
-
diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_form_template.md
@@ -92,6 +92,7 @@ timestamp of when the document was created.
 #### [`id`](../metadata.md#id) Validation
 
 The document ID validation is performed based on timestamp thresholds:
+
 * If `future_threshold` is configured, the document `id` cannot be too far in the future from the
   current time.
 * If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -191,4 +192,3 @@ Only the original author can update and sign a new version of documents.
 [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12
 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
-
diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_moderation_action.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_moderation_action.md
@@ -78,6 +78,7 @@ timestamp of when the document was created.
 #### [`id`](../metadata.md#id) Validation
 
 The document ID validation is performed based on timestamp thresholds:
+
 * If `future_threshold` is configured, the document `id` cannot be too far in the future from the
   current time.
 * If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -182,4 +183,3 @@ Only the original author can update and sign a new version of documents.
 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
 [IPFS-CID]: https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
-
diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_submission_action.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_submission_action.md
@@ -104,6 +104,7 @@ timestamp of when the document was created.
 #### [`id`](../metadata.md#id) Validation
 
 The document ID validation is performed based on timestamp thresholds:
+
 * If `future_threshold` is configured, the document `id` cannot be too far in the future from the
   current time.
 * If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -343,4 +344,3 @@ of the referenced document specified by the 'ref' metadata field.
 [IPFS-CID]: https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
 [RFC8259]: https://www.rfc-editor.org/rfc/rfc8259.html
-
diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination.md b/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination.md
@@ -122,6 +122,7 @@ timestamp of when the document was created.
 #### [`id`](../metadata.md#id) Validation
 
 The document ID validation is performed based on timestamp thresholds:
+
 * If `future_threshold` is configured, the document `id` cannot be too far in the future from the
   current time.
 * If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -304,4 +305,3 @@ Only the original author can update and sign a new version of documents.
 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
 [IPFS-CID]: https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
-
diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination_form_template.md
@@ -92,6 +92,7 @@ timestamp of when the document was created.
 #### [`id`](../metadata.md#id) Validation
 
 The document ID validation is performed based on timestamp thresholds:
+
 * If `future_threshold` is configured, the document `id` cannot be too far in the future from the
   current time.
 * If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -189,4 +190,3 @@ Only the original author can update and sign a new version of documents.
 [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12
 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
-
diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile.md b/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile.md
@@ -77,6 +77,7 @@ timestamp of when the document was created.
 #### [`id`](../metadata.md#id) Validation
 
 The document ID validation is performed based on timestamp thresholds:
+
 * If `future_threshold` is configured, the document `id` cannot be too far in the future from the
   current time.
 * If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -217,4 +218,3 @@ Only the original author can update and sign a new version of documents.
 [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12
 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
-
diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile_form_template.md
@@ -92,6 +92,7 @@ timestamp of when the document was created.
 #### [`id`](../metadata.md#id) Validation
 
 The document ID validation is performed based on timestamp thresholds:
+
 * If `future_threshold` is configured, the document `id` cannot be too far in the future from the
   current time.
 * If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -189,4 +190,3 @@ Only the original author can update and sign a new version of documents.
 [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12
 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
-
diff --git a/docs/src/architecture/08_concepts/signed_doc/metadata.md b/docs/src/architecture/08_concepts/signed_doc/metadata.md
@@ -176,6 +176,7 @@ timestamp of when the document was created.
 #### `id` Validation
 
 The document ID validation is performed based on timestamp thresholds:
+
 * If `future_threshold` is configured, the document `id` cannot be too far in the future from the
     current time.
 * If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -640,4 +641,3 @@ classDiagram
 [RFC9562-V4]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-4
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
 [RFC9562]: https://www.rfc-editor.org/rfc/rfc9562.html
-
diff --git a/specs/definitions/signed_docs/metadata.cue b/specs/definitions/signed_docs/metadata.cue
@@ -140,8 +140,11 @@ _allMetadataNames: or([
 			"""
 		validation: """
 			The document ID validation is performed based on timestamp thresholds:
-			* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.
-			* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time.
+
+			* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
+    current time.
+			* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
+    current time.
 			"""
 	}
 
diff --git a/specs/definitions/signed_docs/metadata_ver.cue b/specs/definitions/signed_docs/metadata_ver.cue
@@ -46,8 +46,10 @@ _ver_description_sequenced: """
 		validation: """
 			1. The document version must always be >= the document ID.
 			2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.
-			3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.
-			4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`.
+			3. When a document with the same `id` already exists, the new document's `ver` must be greater than
+    the latest known submitted version for that `id`.
+			4. When a document with the same `id` already exists, the new document's `type` must be the same as
+    the latest known submitted document's `type` for that `id`.
 			"""
 	}
 }
diff --git a/specs/signed_doc.json b/specs/signed_doc.json
