Skip to content

Commit 4c7f92b

Browse files
committed
wip
1 parent 45bedde commit 4c7f92b

File tree

6 files changed

+21
-19
lines changed

6 files changed

+21
-19
lines changed

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ is just the metadata that structure will carry for different kinds of documents.
5656
Catalyst signed document is a [Catalyst Signed Document],
5757
so its fully follows the structure of the [Catalyst Signed Document] specification.
5858

59-
* [`content type`](./../signed_doc/index.md#content-type): `application/json`.
60-
[Catalyst Signed Document content](./../signed_doc/index.md#signed-object-content) must be in [Json] format.
59+
* [`content type`](./../signed_doc/spec.md#content-type): `application/json`.
60+
[Catalyst Signed Document content](./../signed_doc/spec.md#signed-object-content) must be in [Json] format.
6161

6262
```CDDL
6363
3 => 30
@@ -97,7 +97,7 @@ Document Contents are signed documents, and are typically produced in accordance
9797
Documents will contain metadata which allows the document to be categorized, versioned and linked.
9898
This data does not properly belong inside the document,
9999
but is critical to ensure the document is properly referenced and indexable.
100-
It is defined and specified as [Catalyst Signed Document protected header fields](./../signed_doc/index.md#signed-object-fields).
100+
It is defined and specified as [Catalyst Signed Document protected header fields](./../signed_doc/spec.md#signed-object-fields).
101101

102102
```CDDL
103103
? "ref" => reference_type,
@@ -110,15 +110,15 @@ It is defined and specified as [Catalyst Signed Document protected header fields
110110
#### Document Reference : `ref` (optional)
111111

112112
This is a reference to another document.
113-
The purpose of the `ref` will vary depending on the document [`type`](./../signed_doc/index.md#type).
113+
The purpose of the `ref` will vary depending on the document [`type`](./../signed_doc/spec.md#type).
114114

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

117-
If the `ref` is a single [UUID], it is a reference to the document of that [`id`](./../signed_doc/index.md#id).
117+
If the `ref` is a single [UUID], it is a reference to the document of that [`id`](./../signed_doc/spec.md#id).
118118
If the `ref` is a [CBOR] array, it has the form `[<id>,<ver>]` where:
119119

120-
* `<id>` = the [UUID] of the referenced documents [`id`](./../signed_doc/index.md#id)
121-
* `<ver>` = the [UUID] of the referenced documents [`ver`](./../signed_doc/index.md#ver).
120+
* `<id>` = the [UUID] of the referenced documents [`id`](./../signed_doc/spec.md#id)
121+
* `<ver>` = the [UUID] of the referenced documents [`ver`](./../signed_doc/spec.md#ver).
122122

123123
#### Template Reference : `template` (optional)
124124

@@ -194,8 +194,8 @@ which is a reference to another comment,
194194
where the comment is in reply to the referenced comment.
195195

196196
Comments may only [`reply`](#document-reference--reply-optional) to a single other comment document.
197-
The referenced `comment` must be for the same proposal [`id`](./../signed_doc/index.md#id),
198-
but can be for a different proposal [`ver`](./../signed_doc/index.md#ver).
197+
The referenced `comment` must be for the same proposal [`id`](./../signed_doc/spec.md#id),
198+
but can be for a different proposal [`ver`](./../signed_doc/spec.md#ver).
199199

200200
Comments may *OPTIONALLY* also contain a [`section`](#document-reference--section-optional) field,
201201
when the comment only applies to a specific section to the document being commented upon,
@@ -228,7 +228,7 @@ Fund 14 project catalyst will deploy this scheme for Key derivation.>
228228

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

231-
[Catalyst Signed Document]: ./../signed_doc/index.md
231+
[Catalyst Signed Document]: ./../signed_doc/spec.md
232232
[JSON Schema]: https://json-schema.org/draft-07
233233
[Brotli]: https://datatracker.ietf.org/doc/html/rfc7932
234234
[JSON]: https://datatracker.ietf.org/doc/html/rfc7159

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,18 @@ Project "Catalyst" requires a structure to keep people vote's data in the secure
2626
Generalized vote transaction is a [Catalyst Signed Document],
2727
so its fully follows the structure of the [Catalyst Signed Document] specification.
2828

29-
* [`content type`](./../signed_doc/index.md#content-type): `application/cbor`.
30-
[Catalyst Signed Document content](./../signed_doc/index.md#signed-object-content) must be a [CBOR] encoded.
29+
* [`content type`](./../signed_doc/spec.md#content-type): `application/cbor`.
30+
[Catalyst Signed Document content](./../signed_doc/spec.md#signed-object-content) must be a [CBOR] encoded.
3131

3232
```CDDL
3333
3 => 50
3434
```
3535

36-
* [`content encoding`](./../signed_doc/index.md#content-encoding-optional): is missing
36+
* [`content encoding`](./../signed_doc/spec.md#content-encoding-optional): is missing
3737

3838
### Content format
3939

40-
The generalized vote transaction [content format](./../signed_doc/index.md#signed-object-content)
40+
The generalized vote transaction [content format](./../signed_doc/spec.md#signed-object-content)
4141

4242
<!-- markdownlint-disable max-one-sentence-per-line code-block-style -->
4343
??? note "vote transaction definition: `gen_vote_tx.cddl`"
@@ -70,5 +70,5 @@ Vote:
7070

7171
<!-- OPTIONAL SECTIONS: see CIP-0001 > Document > Structure table -->
7272

73-
[Catalyst Signed Document]: ./../signed_doc/index.md
73+
[Catalyst Signed Document]: ./../signed_doc/spec.md
7474
[CBOR]: https://datatracker.ietf.org/doc/rfc8949/

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ defined on top the ["Generalized Vote Transaction"](./gen_vote_tx.md#specificati
2626

2727
Following that spec need to define a `choice`, `proof` and `prop-id`.
2828

29-
Also additional [Catalyst Signed Document protected header fields](./../signed_doc/index.md#catalyst-signed-document-fields) are defined,
29+
Also additional [Catalyst Signed Document protected header fields](./../signed_doc/spec.md#catalyst-signed-document-fields) are defined,
3030

3131
```CDDL
3232
"brand_id" => UUID, ; UUID v4
@@ -54,7 +54,7 @@ Also additional [Catalyst Signed Document protected header fields](./../signed_d
5454
```
5555
<!-- markdownlint-enable max-one-sentence-per-line code-block-style -->
5656

57-
For the public vote [`type`](./../signed_doc/index.md#type) value defined as follows:
57+
For the public vote [`type`](./../signed_doc/spec.md#type) value defined as follows:
5858

5959
```CDDL
6060
vote-type = #6.37(h'8DE5586CE9984B9587427BE3C8592803') ; 8de5586c-e998-4b95-8742-7be3c8592803
@@ -70,7 +70,7 @@ vote-type = #6.37(h'8DE5586CE9984B9587427BE3C8592803') ; 8de5586c-e998-4b95-8742
7070
```
7171
<!-- markdownlint-enable max-one-sentence-per-line code-block-style -->
7272

73-
For the private vote [`type`](./../signed_doc/index.md#type) value defined as follows:
73+
For the private vote [`type`](./../signed_doc/spec.md#type) value defined as follows:
7474

7575
```CDDL
7676
vote-type = #6.37(h'E78EE18DF38044C1A85280AA6ECB07FE') ; e78ee18d-f380-44c1-a852-80aa6ecb07fe
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
title: Catalyst Signed Document
22
nav:
3-
- Catalyst Signed Document Specification: index.md
3+
- Specification: spec.md
4+
- Metadata Fields List: meta.md
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Something
File renamed without changes.

0 commit comments

Comments
 (0)