Skip to content

Commit 080b53f

Browse files
committed
fix mkdocs
1 parent 6b90ad4 commit 080b53f

File tree

8 files changed

+39
-28
lines changed

8 files changed

+39
-28
lines changed

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

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,17 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do
3939
3 => 30
4040
```
4141

42-
* [`content encoding`](./../signed_doc/spec.md#content-encoding-optional): [Catalyst Signed Document content] must be [Brotli] compressed.
42+
* [`content encoding`](./../signed_doc/spec.md#content-encoding-optional):
43+
[Catalyst Signed Document content] must be [Brotli] compressed.
4344

4445
```CDDL
4546
"content-type" => "br"
4647
```
4748

48-
* [`ref`](./../signed_doc/meta.md#ref-document-reference). Reference to a related [Proposal Document].
49-
* [`template`](./../signed_doc/meta.md#ref-document-reference) must be equal to `0b8424d4-ebfd-46e3-9577-1775a69d290c` value, [comment template type](#comment-template).
49+
* [`ref`](./../signed_doc/meta.md#ref-document-reference).
50+
Reference to a related [Proposal Document].
51+
* [`template`](./../signed_doc/meta.md#ref-document-reference) must be equal to `0b8424d4-ebfd-46e3-9577-1775a69d290c` value,
52+
[comment template type](#comment-template).
5053

5154
```CDDL
5255
"template" => 37(h'0b8424d4ebfd46e395771775a69d290c')
@@ -91,7 +94,8 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do
9194
3 => 30
9295
```
9396

94-
* [`content encoding`](./../signed_doc/spec.md#content-encoding-optional): [Catalyst Signed Document content] must be [Brotli] compressed.
97+
* [`content encoding`](./../signed_doc/spec.md#content-encoding-optional):
98+
[Catalyst Signed Document content] must be [Brotli] compressed.
9599

96100
```CDDL
97101
"content-type" => "br"

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,16 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do
4343
3 => 30
4444
```
4545

46-
* [`content encoding`](./../signed_doc/spec.md#content-encoding-optional): [Catalyst Signed Document content] must be [Brotli] compressed.
46+
* [`content encoding`](./../signed_doc/spec.md#content-encoding-optional):
47+
[Catalyst Signed Document content] must be [Brotli] compressed.
4748

4849
```CDDL
4950
"content-type" => "br"
5051
```
5152

5253
* [`ref`](./../signed_doc/meta.md#ref-document-reference) (optional).
53-
* [`template`](./../signed_doc/meta.md#ref-document-reference) must be equal to `0ce8ab38-9258-4fbc-a62e-7faa6e58318f` value, [proposal template type](#proposal-template).
54+
* [`template`](./../signed_doc/meta.md#ref-document-reference) must be equal to `0ce8ab38-9258-4fbc-a62e-7faa6e58318f` value,
55+
[proposal template type](#proposal-template).
5456

5557
```CDDL
5658
"template" => 37(h'0ce8ab3892584fbca62e7faa6e58318f')
@@ -86,7 +88,8 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do
8688
3 => 30
8789
```
8890

89-
* [`content encoding`](./../signed_doc/spec.md#content-encoding-optional): [Catalyst Signed Document content] must be [Brotli] compressed.
91+
* [`content encoding`](./../signed_doc/spec.md#content-encoding-optional):
92+
[Catalyst Signed Document content] must be [Brotli] compressed.
9093

9194
```CDDL
9295
"content-type" => "br"

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,15 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do
3939
3 => 30
4040
```
4141

42-
* [`content encoding`](./../signed_doc/spec.md#content-encoding-optional): [Catalyst Signed Document content] must be [Brotli] compressed.
42+
* [`content encoding`](./../signed_doc/spec.md#content-encoding-optional):
43+
[Catalyst Signed Document content] must be [Brotli] compressed.
4344

4445
```CDDL
4546
"content-type" => "br"
4647
```
4748

48-
* [`template`](./../signed_doc/meta.md#ref-document-reference) must be equal to `ebe5d0bf-5d86-4577-af4d-008fddbe2edc` value, [review template type](#review-template).
49+
* [`template`](./../signed_doc/meta.md#ref-document-reference) must be equal to `ebe5d0bf-5d86-4577-af4d-008fddbe2edc` value,
50+
[review template type](#review-template).
4951

5052
```CDDL
5153
"template" => 37(h'ebe5d0bf5d864577af4d008fddbe2edc')
@@ -77,7 +79,8 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do
7779
3 => 30
7880
```
7981

80-
* [`content encoding`](./../signed_doc/spec.md#content-encoding-optional): [Catalyst Signed Document content] must be [Brotli] compressed.
82+
* [`content encoding`](./../signed_doc/spec.md#content-encoding-optional):
83+
[Catalyst Signed Document content] must be [Brotli] compressed.
8184

8285
```CDDL
8386
"content-type" => "br"

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This document describes a Catalyst V2 vote transaction structure.
1717
Catalyst v2 voting transaction is a [Catalyst Signed Document],
1818
so its fully follows the structure of the [Catalyst Signed Document] specification.
1919

20-
#### Metadata Fields
20+
### Metadata Fields
2121

2222
A list of used [Catalyst Signed Document protected header fields](./../signed_doc/spec.md#signed-object-fields).
2323

@@ -44,14 +44,14 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do
4444
3 => 50
4545
```
4646

47-
* [`content encoding`](./../signed_doc/spec.md#content-encoding-optional): [Catalyst Signed Document content] must be [Brotli] compressed.
47+
* [`content encoding`](./../signed_doc/spec.md#content-encoding-optional):
48+
[Catalyst Signed Document content] must be [Brotli] compressed.
4849

4950
```CDDL
5051
"content-type" => "br"
5152
```
5253

53-
54-
##### Public vote
54+
#### Public vote
5555

5656
For the public vote [`type`](./../signed_doc/spec.md#type) value defined as follows:
5757

@@ -61,7 +61,7 @@ For the public vote [`type`](./../signed_doc/spec.md#type) value defined as foll
6161
"type" => 37(h'8DE5586CE9984B9587427BE3C8592803')
6262
```
6363

64-
###### Content format
64+
##### Content format
6565

6666
The public vote transaction [Catalyst Signed Document content] format is based on the [Generalized Vote Transaction Structure].
6767

@@ -75,7 +75,7 @@ Following that spec need to define a `choice`, `proof` and `prop-id`.
7575
```
7676
<!-- markdownlint-enable max-one-sentence-per-line code-block-style -->
7777

78-
##### Private vote
78+
#### Private vote
7979

8080
For the private vote [`type`](./../signed_doc/spec.md#type) value defined as follows:
8181

@@ -85,7 +85,7 @@ For the private vote [`type`](./../signed_doc/spec.md#type) value defined as fol
8585
"type" => 37(h'E78EE18DF38044C1A85280AA6ECB07FE')
8686
```
8787

88-
###### Content format
88+
##### Content format
8989

9090
The private vote transaction [Catalyst Signed Document content] format is based on the [Generalized Vote Transaction Structure].
9191

@@ -99,7 +99,7 @@ Following that spec need to define a `choice`, `proof` and `prop-id`.
9999
```
100100
<!-- markdownlint-enable max-one-sentence-per-line code-block-style -->
101101

102-
###### Vote and Proof generation
102+
##### Vote and Proof generation
103103

104104
To generate a cryptographically secured `choice-data` and `zk_proof` parts you can follow this [spec](./crypto.md#vote).
105105
Important to note,
@@ -129,4 +129,4 @@ the following properties are used:
129129
[ristretto255]: https://ristretto.group
130130
[Brotli]: https://datatracker.ietf.org/doc/html/rfc7932
131131
[UUID]: https://www.rfc-editor.org/rfc/rfc9562.html
132-
[CBOR]: https://datatracker.ietf.org/doc/rfc8949/
132+
[CBOR]: https://datatracker.ietf.org/doc/rfc8949/
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
title: Catalyst Signed Document
22
nav:
3-
- Specification: spec.md
4-
- Metadata Fields List: meta.md
5-
- Document Types: types.md
3+
- Specification: spec.md
4+
- Metadata Fields: meta.md
5+
- Document Types: types.md

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# Metadata Fields List
12

23
<!-- markdownlint-disable max-one-sentence-per-line code-block-style -->
34
??? note "Additional Metadata fields: `additional_meta.cddl`"
@@ -79,4 +80,3 @@ It does NOT mean that the listed collaborators have agreed to collaborate, only
7980
gives them permission to.*
8081

8182
This list can impact actions that can be performed by the `Proposal Action Document`.
82-

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,8 @@ be well constructed.
9191

9292
Creating `id` this way ensures there are no collisions, and they can be independently created without central co-ordination.
9393

94-
*Note: All Catalyst Signed Documents are signed, the first creation of an `id` assigns that `id` to the creator and any assigned collaborators.
94+
*Note: All Catalyst Signed Documents are signed,
95+
the first creation of an `id` assigns that `id` to the creator and any assigned collaborators.
9596
A Catalyst Signed Document that is not signed by the creator, or an assigned collaborator, is invalid.
9697
There is no reasonable way an `id` can collide accidentally.
9798
Therefore, detection of invalid `id`s published by unauthorized publishers, could result in anti-spam
@@ -161,13 +162,13 @@ signature_protected_header = {
161162
```
162163
<!-- markdownlint-enable code-block-style -->
163164

164-
* `kid`: A unique identifier of the signer. A [UTF-8] encoded [URI] string.
165+
* `kid`: A unique identifier of the signer.
166+
A [UTF-8] encoded [URI] string.
165167

166168
## Copyright
167169

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

170-
171172
[Brotli]: https://datatracker.ietf.org/doc/html/rfc7932
172173
[UTF-8]: https://datatracker.ietf.org/doc/html/rfc3629
173174
[URI]: https://datatracker.ietf.org/doc/html/rfc3986

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# Document Types Table
12

23
| [UUID] | [CBOR] | Type Description | Payload Type | Specification Link |
34
| ------------------------------------ | ----------------------------------------- | ---------------------------- | --------------------------------- | -------------------------------------------------------------------------- |
@@ -17,9 +18,8 @@
1718
| 8de5586c-e998-4b95-8742-7be3c8592803 | `37(h'8DE5586CE9984B9587427BE3C8592803')` | Public Vote Tx V2 | [Brotli] Compressed [CBOR] | [Public Vote Tx V2 Spec](./../catalyst_voting/v2.md#public-vote) |
1819
| e78ee18d-f380-44c1-a852-80aa6ecb07fe | `37(h'E78EE18DF38044C1A85280AA6ECB07FE')` | Private Vote Tx V2 | [Brotli] Compressed [CBOR] | [Private Vote Tx V2 Spec](./../catalyst_voting/v2.md#private-vote) |
1920

20-
2121
[JSON Schema]: https://json-schema.org/draft-07
2222
[JSON]: https://datatracker.ietf.org/doc/html/rfc7159
2323
[Brotli]: https://datatracker.ietf.org/doc/html/rfc7932
2424
[CBOR]: https://datatracker.ietf.org/doc/html/rfc8610
25-
[UUID]: https://www.rfc-editor.org/rfc/rfc9562.html
25+
[UUID]: https://www.rfc-editor.org/rfc/rfc9562.html

0 commit comments

Comments
 (0)