Skip to content

Commit 0388666

Browse files
committed
fix(docs): enhance formatting of ID validation rules in signed document metadata
- Standardize the presentation of ID validation rules across multiple documentation files to improve readability. - Add missing newlines for better separation of criteria related to timestamp thresholds for future and past limits. - Update the signed_doc.json specification to reflect the improved formatting standards.
1 parent 404ce15 commit 0388666

25 files changed

+50
-26
lines changed

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,10 +87,11 @@ timestamp of when the document was created.
8787
#### [`id`](../metadata.md#id) Validation
8888

8989
The document ID validation is performed based on timestamp thresholds:
90+
9091
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
91-
current time.
92+
current time.
9293
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
93-
current time.
94+
current time.
9495

9596
<!-- markdownlint-disable MD033 -->
9697
| Parameter | Value |

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ timestamp of when the document was created.
9292
#### [`id`](../metadata.md#id) Validation
9393

9494
The document ID validation is performed based on timestamp thresholds:
95+
9596
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
9697
current time.
9798
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ timestamp of when the document was created.
8888
#### [`id`](../metadata.md#id) Validation
8989

9090
The document ID validation is performed based on timestamp thresholds:
91+
9192
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
9293
current time.
9394
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ timestamp of when the document was created.
9292
#### [`id`](../metadata.md#id) Validation
9393

9494
The document ID validation is performed based on timestamp thresholds:
95+
9596
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
9697
current time.
9798
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ timestamp of when the document was created.
8888
#### [`id`](../metadata.md#id) Validation
8989

9090
The document ID validation is performed based on timestamp thresholds:
91+
9192
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
9293
current time.
9394
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ timestamp of when the document was created.
9292
#### [`id`](../metadata.md#id) Validation
9393

9494
The document ID validation is performed based on timestamp thresholds:
95+
9596
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
9697
current time.
9798
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ timestamp of when the document was created.
7878
#### [`id`](../metadata.md#id) Validation
7979

8080
The document ID validation is performed based on timestamp thresholds:
81+
8182
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
8283
current time.
8384
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ timestamp of when the document was created.
8989
#### [`id`](../metadata.md#id) Validation
9090

9191
The document ID validation is performed based on timestamp thresholds:
92+
9293
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
9394
current time.
9495
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ timestamp of when the document was created.
111111
#### [`id`](../metadata.md#id) Validation
112112

113113
The document ID validation is performed based on timestamp thresholds:
114+
114115
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
115116
current time.
116117
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,7 @@ timestamp of when the document was created.
148148
#### [`id`](../metadata.md#id) Validation
149149

150150
The document ID validation is performed based on timestamp thresholds:
151+
151152
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
152153
current time.
153154
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the

0 commit comments

Comments
 (0)