Skip to content

Commit fb99b47

Browse files
committed
feat(docs): wip
1 parent 83e1828 commit fb99b47

20 files changed

+253
-54
lines changed

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,11 @@ are permitting these potential collaborators to participate in the drafting and
144144
However, any document submission referencing a proposal MUST be signed by all collaborators in
145145
addition to the author.
146146

147+
In the event there are **MULTIPLE** [`collaborators`](../metadata.md#collaborators) listed, they **MUST** be sorted.
148+
149+
Sorting for each element of [`collaborators`](../metadata.md#collaborators) follows the same sort order as specified for Map Keys,
150+
as defined by [CBOR Deterministic Encoding][CBOR-LFD-ENCODING] (4.3.2 Length-First Map Key Ordering).
151+
147152
### [`revocations`](../metadata.md#revocations)
148153

149154
<!-- markdownlint-disable MD033 -->
@@ -211,6 +216,7 @@ of the previous submitted document's version.
211216

212217
* Generalized as another kind of form data document
213218

219+
[CBOR-LFD-ENCODING]: https://www.rfc-editor.org/rfc/rfc8949.html#section-4.2.3
214220
[RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1
215221
[CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
216222
[RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,11 @@ are permitting these potential collaborators to participate in the drafting and
145145
However, any document submission referencing a proposal MUST be signed by all collaborators in
146146
addition to the author.
147147

148+
In the event there are **MULTIPLE** [`collaborators`](../metadata.md#collaborators) listed, they **MUST** be sorted.
149+
150+
Sorting for each element of [`collaborators`](../metadata.md#collaborators) follows the same sort order as specified for Map Keys,
151+
as defined by [CBOR Deterministic Encoding][CBOR-LFD-ENCODING] (4.3.2 Length-First Map Key Ordering).
152+
148153
### [`revocations`](../metadata.md#revocations)
149154

150155
<!-- markdownlint-disable MD033 -->
@@ -240,6 +245,7 @@ of the previous submitted document's version.
240245

241246
* Generalized as another kind of form data document
242247

248+
[CBOR-LFD-ENCODING]: https://www.rfc-editor.org/rfc/rfc8949.html#section-4.2.3
243249
[RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1
244250
[CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
245251
[RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,11 @@ are permitting these potential collaborators to participate in the drafting and
145145
However, any document submission referencing a proposal MUST be signed by all collaborators in
146146
addition to the author.
147147

148+
In the event there are **MULTIPLE** [`collaborators`](../metadata.md#collaborators) listed, they **MUST** be sorted.
149+
150+
Sorting for each element of [`collaborators`](../metadata.md#collaborators) follows the same sort order as specified for Map Keys,
151+
as defined by [CBOR Deterministic Encoding][CBOR-LFD-ENCODING] (4.3.2 Length-First Map Key Ordering).
152+
148153
### [`revocations`](../metadata.md#revocations)
149154

150155
<!-- markdownlint-disable MD033 -->
@@ -240,6 +245,7 @@ of the previous submitted document's version.
240245

241246
* Generalized as another kind of form data document
242247

248+
[CBOR-LFD-ENCODING]: https://www.rfc-editor.org/rfc/rfc8949.html#section-4.2.3
243249
[RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1
244250
[CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
245251
[RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,10 @@ The following must be true for a valid reference:
137137
* The Referenced Document **MUST** Exist
138138
* Every value in the `document_locator` must consistently reference the exact same document.
139139
* The `document_id` and `document_ver` **MUST** match the values in the referenced document.
140+
* In the event there are **MULTIPLE** [`ref`](../metadata.md#ref) listed, they **MUST** be sorted.
141+
142+
Sorting for each element of [`ref`](../metadata.md#ref) follows the same sort order as specified for Map Keys,
143+
as defined by [CBOR Deterministic Encoding][CBOR-LFD-ENCODING] (4.3.2 Length-First Map Key Ordering).
140144

141145
## Payload
142146

@@ -172,6 +176,7 @@ Only the original author can update and sign a new version of documents.
172176
* First Published Version
173177

174178
[CBOR-TAG-42]: https://github.com/ipld/cid-cbor/
179+
[CBOR-LFD-ENCODING]: https://www.rfc-editor.org/rfc/rfc8949.html#section-4.2.3
175180
[RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1
176181
[CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
177182
[IPFS-CID]: https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,10 @@ The following must be true for a valid reference:
171171
* The Referenced Document **MUST** Exist
172172
* Every value in the `document_locator` must consistently reference the exact same document.
173173
* The `document_id` and `document_ver` **MUST** match the values in the referenced document.
174+
* In the event there are **MULTIPLE** [`ref`](../metadata.md#ref) listed, they **MUST** be sorted.
175+
176+
Sorting for each element of [`ref`](../metadata.md#ref) follows the same sort order as specified for Map Keys,
177+
as defined by [CBOR Deterministic Encoding][CBOR-LFD-ENCODING] (4.3.2 Length-First Map Key Ordering).
174178

175179
### [`parameters`](../metadata.md#parameters)
176180

@@ -525,6 +529,7 @@ Only the original author can update and sign a new version of documents.
525529
* Add Voting Ballots and Ballot Checkpoint Documents
526530

527531
[CBOR-TAG-42]: https://github.com/ipld/cid-cbor/
532+
[CBOR-LFD-ENCODING]: https://www.rfc-editor.org/rfc/rfc8949.html#section-4.2.3
528533
[RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1
529534
[CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
530535
[IPFS-CID]: https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,10 @@ The following must be true for a valid reference:
208208
* The Referenced Document **MUST** Exist
209209
* Every value in the `document_locator` must consistently reference the exact same document.
210210
* The `document_id` and `document_ver` **MUST** match the values in the referenced document.
211+
* In the event there are **MULTIPLE** [`ref`](../metadata.md#ref) listed, they **MUST** be sorted.
212+
213+
Sorting for each element of [`ref`](../metadata.md#ref) follows the same sort order as specified for Map Keys,
214+
as defined by [CBOR Deterministic Encoding][CBOR-LFD-ENCODING] (4.3.2 Length-First Map Key Ordering).
211215

212216
### [`revocations`](../metadata.md#revocations)
213217

@@ -372,6 +376,7 @@ Only the original author can update and sign a new version of documents.
372376
* Allow Multi Delegation
373377

374378
[CBOR-TAG-42]: https://github.com/ipld/cid-cbor/
379+
[CBOR-LFD-ENCODING]: https://www.rfc-editor.org/rfc/rfc8949.html#section-4.2.3
375380
[RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1
376381
[CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
377382
[IPFS-CID]: https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,11 @@ are permitting these potential collaborators to participate in the drafting and
145145
However, any document submission referencing a proposal MUST be signed by all collaborators in
146146
addition to the author.
147147

148+
In the event there are **MULTIPLE** [`collaborators`](../metadata.md#collaborators) listed, they **MUST** be sorted.
149+
150+
Sorting for each element of [`collaborators`](../metadata.md#collaborators) follows the same sort order as specified for Map Keys,
151+
as defined by [CBOR Deterministic Encoding][CBOR-LFD-ENCODING] (4.3.2 Length-First Map Key Ordering).
152+
148153
### [`revocations`](../metadata.md#revocations)
149154

150155
<!-- markdownlint-disable MD033 -->
@@ -242,6 +247,7 @@ of the previous submitted document's version.
242247

243248
* Generalized as another kind of form data document
244249

250+
[CBOR-LFD-ENCODING]: https://www.rfc-editor.org/rfc/rfc8949.html#section-4.2.3
245251
[RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1
246252
[CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
247253
[RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ of the document they are signing, provided they are listed as a collaborator in
3737
This allows for a collaborator to make an update to the document which removes themselves
3838
from the [`collaborators`](../metadata.md#collaborators) list.
3939

40-
All versions of the document *MUST* list the author as the original author.
40+
All versions of the document are owned by the original author.
4141
The Author can not be changed by any document revision.
4242

4343
Any Proposal that lists a collaborator is an invitation for that collaborator to participate in the proposal.
@@ -171,6 +171,11 @@ are permitting these potential collaborators to participate in the drafting and
171171
However, any document submission referencing a proposal MUST be signed by all collaborators in
172172
addition to the author.
173173

174+
In the event there are **MULTIPLE** [`collaborators`](../metadata.md#collaborators) listed, they **MUST** be sorted.
175+
176+
Sorting for each element of [`collaborators`](../metadata.md#collaborators) follows the same sort order as specified for Map Keys,
177+
as defined by [CBOR Deterministic Encoding][CBOR-LFD-ENCODING] (4.3.2 Length-First Map Key Ordering).
178+
174179
### [`revocations`](../metadata.md#revocations)
175180

176181
<!-- markdownlint-disable MD033 -->
@@ -272,6 +277,7 @@ of the previous submitted document's version.
272277

273278
* Use generalized parameters.
274279

280+
[CBOR-LFD-ENCODING]: https://www.rfc-editor.org/rfc/rfc8949.html#section-4.2.3
275281
[RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1
276282
[CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
277283
[RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,10 @@ The following must be true for a valid reference:
139139
* The Referenced Document **MUST** Exist
140140
* Every value in the `document_locator` must consistently reference the exact same document.
141141
* The `document_id` and `document_ver` **MUST** match the values in the referenced document.
142+
* In the event there are **MULTIPLE** [`ref`](../metadata.md#ref) listed, they **MUST** be sorted.
143+
144+
Sorting for each element of [`ref`](../metadata.md#ref) follows the same sort order as specified for Map Keys,
145+
as defined by [CBOR Deterministic Encoding][CBOR-LFD-ENCODING] (4.3.2 Length-First Map Key Ordering).
142146

143147
### [`template`](../metadata.md#template)
144148

@@ -291,6 +295,7 @@ Only the original author can update and sign a new version of documents.
291295
* Use generalized parameters.
292296

293297
[CBOR-TAG-42]: https://github.com/ipld/cid-cbor/
298+
[CBOR-LFD-ENCODING]: https://www.rfc-editor.org/rfc/rfc8949.html#section-4.2.3
294299
[RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1
295300
[CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
296301
[IPFS-CID]: https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,10 @@ The following must be true for a valid reference:
137137
* The Referenced Document **MUST** Exist
138138
* Every value in the `document_locator` must consistently reference the exact same document.
139139
* The `document_id` and `document_ver` **MUST** match the values in the referenced document.
140+
* In the event there are **MULTIPLE** [`ref`](../metadata.md#ref) listed, they **MUST** be sorted.
141+
142+
Sorting for each element of [`ref`](../metadata.md#ref) follows the same sort order as specified for Map Keys,
143+
as defined by [CBOR Deterministic Encoding][CBOR-LFD-ENCODING] (4.3.2 Length-First Map Key Ordering).
140144

141145
## Payload
142146

@@ -172,6 +176,7 @@ Only the original author can update and sign a new version of documents.
172176
* First Published Version
173177

174178
[CBOR-TAG-42]: https://github.com/ipld/cid-cbor/
179+
[CBOR-LFD-ENCODING]: https://www.rfc-editor.org/rfc/rfc8949.html#section-4.2.3
175180
[RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1
176181
[CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
177182
[IPFS-CID]: https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid

0 commit comments

Comments
 (0)