Skip to content

Commit 84d2956

Browse files
committed
fix comments
1 parent 2cd3a35 commit 84d2956

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,3 +108,4 @@ e.g. "Development & Infrastructure", "Products & Integrations".
108108

109109
[UUID]: https://www.rfc-editor.org/rfc/rfc9562.html
110110
[CBOR]: https://datatracker.ietf.org/doc/rfc8949/
111+
[JSON Path]: https://datatracker.ietf.org/doc/html/rfc9535

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ License: CC-BY-4.0
3131
Project Catalyst both produces and consumes a lot of different data objects,
3232
in different places of the system.
3333
To ensure the data object is authoritative, it must be signed.
34-
Id addition to the data object content and the signature, metadata is also included
34+
In addition to the data object content and the signature, metadata is also included
3535
to describe different kind of Catalyst Signed Document properties.
3636

3737
## Motivation: why is this CIP necessary?
@@ -46,7 +46,7 @@ It fully inherits an original [COSE] design and specifies the details of differe
4646

4747
### Catalyst Signed Document metadata fields
4848

49-
To uniquely specify a Catalyst Signed Document type, version etc., as it was mentioned before,
49+
To uniquely specify a Catalyst Signed Document `id`, `type`, `version` etc.,
5050
a list of different metadata fields is specified.
5151

5252
Also as you can see from the specification,
@@ -75,7 +75,7 @@ The `type` is a [UUID] v4.
7575
#### `id`
7676

7777
Every Catalyst Signed Document will have a unique ID.
78-
All Catalyst Signed Document with the same `id` are considered versions of the same Catalyst Signed Document
78+
All Catalyst Signed Document with the same `id` are considered different versions of the same Catalyst Signed Document
7979
(read about [`ver`](#ver)).
8080
However, `id` uniqueness is only guaranteed on first use.
8181

0 commit comments

Comments
 (0)