Skip to content

Commit 0dfc4b6

Browse files
committed
fix markdown check
1 parent 3017e51 commit 0dfc4b6

File tree

4 files changed

+28
-23
lines changed

4 files changed

+28
-23
lines changed

docs/src/architecture/08_concepts/catalyst_docs/index.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ License: CC-BY-4.0
3636
* [Implementation Plan](#implementation-plan)
3737
* [Copyright](#copyright)
3838

39-
4039
## Abstract
4140

4241
Project Catalyst both produces and consumes documents of data (proposals, reviews, comments).
@@ -59,10 +58,14 @@ so its fully follows the structure of the [signed object] specification.
5958

6059
* [`content type`](./../signed_object/index.md#content-type): `application/json`.
6160
[Signed object content](./../signed_object/index.md#signed-object-content) must be in [Json] format.
61+
6262
```CDDL
6363
3 => 30
6464
```
65-
* [`content encoding`](./../signed_object/index.md#content-encoding-optional): `"br"`. [Signed object content](./../signed_object/index.md#signed-object-content) must be [Brotli] compressed.
65+
66+
* [`content encoding`](./../signed_object/index.md#content-encoding-optional): `"br"`.
67+
[Signed object content](./../signed_object/index.md#signed-object-content) must be [Brotli] compressed.
68+
6669
```CDDL
6770
"content encoding" => "br"
6871
```
@@ -114,20 +117,20 @@ It is defined and specified as [signed object protected header fields](./../sign
114117
#### Document Reference : `ref` (optional)
115118

116119
This is a reference to another document.
117-
The purpose of the `ref` will vary depending on the document [`type`](#document-type--type).
120+
The purpose of the `ref` will vary depending on the document [`type`](./../signed_object/index.md#type).
118121

119122
The `ref` can be either a single [UUID] or a [CBOR] Array of Two [UUID].
120123

121-
If the `ref` is a single [UUID], it is a reference to the document of that [`id`](#document-id--id).
124+
If the `ref` is a single [UUID], it is a reference to the document of that [`id`](./../signed_object/index.md#id).
122125
If the `ref` is a [CBOR] array, it has the form `[<id>,<ver>]` where:
123126

124-
* `<id>` = the [UUID] of the referenced documents [`id`](#document-id--id)
125-
* `<ver>` = the [UUID] of the referenced documents [`ver`](#document-version--ver).
127+
* `<id>` = the [UUID] of the referenced documents [`id`](./../signed_object/index.md#id)
128+
* `<ver>` = the [UUID] of the referenced documents [`ver`](./../signed_object/index.md#ver).
126129

127130
#### Template Reference : `template` (optional)
128131

129132
If the document was formed from a template, this is a reference to that template document.
130-
The format is the same as the [CBOR] Array form of [`ref`](#document-reference--ref).
133+
The format is the same as the [CBOR] Array form of [`ref`](#document-reference--ref-optional).
131134

132135
It is invalid not to reference the template that formed a document.
133136
If this is missing from such documents, the document will itself be considered invalid.
@@ -137,7 +140,7 @@ Template references must explicitly reference both the Template Document ID, and
137140
#### Document Reference : `reply` (optional)
138141

139142
This is a reply to another document.
140-
The format is the same as the [CBOR] Array form of [`ref`](#document-reference--ref).
143+
The format is the same as the [CBOR] Array form of [`ref`](#document-reference--ref-optional).
141144

142145
`reply` is always referencing a document of the same type, and that document must `ref` reference the same document `id`.
143146
However, depending on the document type, it may reference a different `ver` of that `id`.
@@ -191,16 +194,17 @@ They are defined when a specific document is submitted for consideration.
191194
#### Comment Document
192195

193196
This is a document which provides a comment against a particular proposal.
194-
Because comments are informed by a particular proposals version, they *MUST* contain a [`ref`](#document-reference--ref)
197+
Because comments are informed by a particular proposals version, they *MUST* contain a [`ref`](#document-reference--ref-optional)
195198

196-
They may *OPTIONALLY* also contain a [`reply`](#document-reference--reply) metadata field, which is a reference to another comment,
199+
They may *OPTIONALLY* also contain a [`reply`](#document-reference--reply-optional) metadata field,
200+
which is a reference to another comment,
197201
where the comment is in reply to the referenced comment.
198202

199-
Comments may only [`reply`](#document-reference--reply) to a single other comment document.
200-
The referenced `comment` must be for the same proposal [`id`](#document-id--id),
201-
but can be for a different proposal [`ver`](#document-version--ver).
203+
Comments may only [`reply`](#document-reference--reply-optional) to a single other comment document.
204+
The referenced `comment` must be for the same proposal [`id`](./../signed_object/index.md#id),
205+
but can be for a different proposal [`ver`](./../signed_object/index.md#ver).
202206

203-
Comments may *OPTIONALLY* also contain a [`subsection`](#document-reference--section) field,
207+
Comments may *OPTIONALLY* also contain a [`section`](#document-reference--section-optional) field,
204208
when the comment only applies to a specific section to the document being commented upon,
205209
and not the entire document.
206210

docs/src/architecture/08_concepts/catalyst_voting/gen_vote_tx.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,11 @@ so its fully follows the structure of the [signed object] specification.
2828

2929
* [`content type`](./../signed_object/index.md#content-type): `application/cbor`.
3030
[Signed object content](./../signed_object/index.md#signed-object-content) must be a [CBOR] encoded.
31+
3132
```CDDL
3233
3 => 50
3334
```
35+
3436
* [`content encoding`](./../signed_object/index.md#content-encoding-optional): is missing
3537

3638
### Content format
@@ -69,6 +71,4 @@ Vote:
6971
<!-- OPTIONAL SECTIONS: see CIP-0001 > Document > Structure table -->
7072

7173
[signed object]: ./../signed_object/index.md
72-
[BLAKE2b-256]: https://www.blake2.net/blake2.pdf
73-
[COSE]: https://datatracker.ietf.org/doc/rfc9052/
7474
[CBOR]: https://datatracker.ietf.org/doc/rfc8949/

docs/src/architecture/08_concepts/catalyst_voting/v2.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,5 @@ the following properties are used:
9999

100100
<!-- OPTIONAL SECTIONS: see CIP-0001 > Document > Structure table -->
101101

102-
[UUID]: https://www.rfc-editor.org/rfc/rfc9562.html
103102
[BLAKE2b-512]: https://www.blake2.net/blake2.pdf
104103
[ristretto255]: https://ristretto.group

docs/src/architecture/08_concepts/signed_object/index.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -102,17 +102,19 @@ There can, and probably will, exist multiple versions of the same document.
102102
The `ver` is a [UUID] V7.
103103

104104
The initial `ver` assigned the first time a signed object is published will be identical to the [`id`](#id).
105-
Subsequent versions will retain the same [`id`](#document-id--id) and will create a new `ver`,
105+
Subsequent versions will retain the same [`id`](#id) and will create a new `ver`,
106106
following best practice for creating a new [UUID] v7.
107107

108108
#### `alg`
109109

110110
This is an original [COSE] header field,
111111
which indicates the cryptography algorithm used for the security processing.
112112

113+
<!-- markdownlint-disable max-one-sentence-per-line -->
113114
!!! warning ""
114115

115116
It must be equal to `EdDSA` value
117+
<!-- markdownlint-enable max-one-sentence-per-line -->
116118

117119
Only `ed25119` considered at this moment as the only option to be supported for signed objects.
118120

@@ -127,7 +129,8 @@ This field is used to indicate the content encodings algorithm of the [content](
127129

128130
### Signed Object content
129131

130-
The signed object content data is encoded (and could be additionaly compressed, read [`content encoding`](#content-encoding-optional)) as [COSE] `payload`.
132+
The signed object content data is encoded (and could be additionaly compressed,
133+
read [`content encoding`](#content-encoding-optional)) as [COSE] `payload`.
131134

132135
### [COSE] signature protected header
133136

@@ -136,23 +139,22 @@ which allows to provide multi-signature functionality.
136139
In that regard,
137140
each Catalyst signed object [COSE] signature **must** include the following `protected` header field:
138141

139-
```cddl
142+
<!-- markdownlint-disable code-block-style -->
143+
```CDDL
140144
; All encoders/decoders of this specification must follow deterministic cbor encoding rules
141145
; https://datatracker.ietf.org/doc/html/draft-ietf-cbor-cde-06
142146
143147
signature_protected_header = {
144148
4 => bytes ; "kid"
145149
}
146150
```
151+
<!-- markdownlint-enable code-block-style -->
147152

148153
* `kid`: A unique identifier of the signer.
149154

150-
151155
## Copyright
152156

153157
This document is licensed under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).
154158

155159
[COSE]: https://datatracker.ietf.org/doc/html/rfc9052
156-
[Brotli]: https://datatracker.ietf.org/doc/html/rfc7932
157-
[CBOR]: https://datatracker.ietf.org/doc/html/rfc8610
158160
[UUID]: https://www.rfc-editor.org/rfc/rfc9562.html

0 commit comments

Comments
 (0)