Skip to content

Commit 4635022

Browse files
authored
fix(docs): Catalyst Signed Document specification fixes (#536)
* update some stuff for signed docs spec * wip * print diff for cue fmt check * fix fmt * fix python * fix md * fix * fix python fmt * fix spelling * fix * update * wip * wip * wip * wip * wip * wip * fix python fmt * cleanup * update changelog * fix * fix
1 parent b9f8882 commit 4635022

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+266
-116
lines changed

docs/src/architecture/08_concepts/signed_doc/diagrams/all.dot

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -577,7 +577,17 @@ digraph "All" {
577577
</TD>
578578
</TR>
579579
<TR>
580-
<TD ALIGN="LEFT" PORT="type" BGCOLOR="#e7e2dd">
580+
<TD ALIGN="LEFT" PORT="content type" BGCOLOR="#e7e2dd">
581+
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
582+
<TR>
583+
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">content type</FONT></TD>
584+
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Undefined</I></FONT></TD>
585+
</TR>
586+
</TABLE>
587+
</TD>
588+
</TR>
589+
<TR>
590+
<TD ALIGN="LEFT" PORT="type" BGCOLOR="#b8b5b0">
581591
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
582592
<TR>
583593
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">type</FONT></TD>
@@ -587,7 +597,7 @@ digraph "All" {
587597
</TD>
588598
</TR>
589599
<TR>
590-
<TD ALIGN="LEFT" PORT="id" BGCOLOR="#b8b5b0">
600+
<TD ALIGN="LEFT" PORT="id" BGCOLOR="#e7e2dd">
591601
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
592602
<TR>
593603
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">id</FONT></TD>
@@ -597,7 +607,7 @@ digraph "All" {
597607
</TD>
598608
</TR>
599609
<TR>
600-
<TD ALIGN="LEFT" PORT="ver" BGCOLOR="#e7e2dd">
610+
<TD ALIGN="LEFT" PORT="ver" BGCOLOR="#b8b5b0">
601611
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
602612
<TR>
603613
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">ver</FONT></TD>
@@ -607,7 +617,7 @@ digraph "All" {
607617
</TD>
608618
</TR>
609619
<TR>
610-
<TD ALIGN="LEFT" PORT="ref" BGCOLOR="#b8b5b0">
620+
<TD ALIGN="LEFT" PORT="ref" BGCOLOR="#e7e2dd">
611621
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
612622
<TR>
613623
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">ref</FONT></TD>
@@ -617,7 +627,7 @@ digraph "All" {
617627
</TD>
618628
</TR>
619629
<TR>
620-
<TD ALIGN="LEFT" PORT="revocations" BGCOLOR="#e7e2dd">
630+
<TD ALIGN="LEFT" PORT="revocations" BGCOLOR="#b8b5b0">
621631
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
622632
<TR>
623633
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">revocations</FONT></TD>
@@ -627,7 +637,7 @@ digraph "All" {
627637
</TD>
628638
</TR>
629639
<TR>
630-
<TD ALIGN="LEFT" PORT="parameters" BGCOLOR="#b8b5b0">
640+
<TD ALIGN="LEFT" PORT="parameters" BGCOLOR="#e7e2dd">
631641
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
632642
<TR>
633643
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">parameters</FONT></TD>

docs/src/architecture/08_concepts/signed_doc/diagrams/all.dot.svg

Lines changed: 39 additions & 35 deletions
Loading

docs/src/architecture/08_concepts/signed_doc/diagrams/contest_delegation.dot

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,17 @@ Relationships"
5353
</TD>
5454
</TR>
5555
<TR>
56-
<TD ALIGN="LEFT" PORT="type" BGCOLOR="#e7e2dd">
56+
<TD ALIGN="LEFT" PORT="content type" BGCOLOR="#e7e2dd">
57+
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
58+
<TR>
59+
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">content type</FONT></TD>
60+
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Undefined</I></FONT></TD>
61+
</TR>
62+
</TABLE>
63+
</TD>
64+
</TR>
65+
<TR>
66+
<TD ALIGN="LEFT" PORT="type" BGCOLOR="#b8b5b0">
5767
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
5868
<TR>
5969
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">type</FONT></TD>
@@ -63,7 +73,7 @@ Relationships"
6373
</TD>
6474
</TR>
6575
<TR>
66-
<TD ALIGN="LEFT" PORT="id" BGCOLOR="#b8b5b0">
76+
<TD ALIGN="LEFT" PORT="id" BGCOLOR="#e7e2dd">
6777
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
6878
<TR>
6979
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">id</FONT></TD>
@@ -73,7 +83,7 @@ Relationships"
7383
</TD>
7484
</TR>
7585
<TR>
76-
<TD ALIGN="LEFT" PORT="ver" BGCOLOR="#e7e2dd">
86+
<TD ALIGN="LEFT" PORT="ver" BGCOLOR="#b8b5b0">
7787
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
7888
<TR>
7989
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">ver</FONT></TD>
@@ -83,7 +93,7 @@ Relationships"
8393
</TD>
8494
</TR>
8595
<TR>
86-
<TD ALIGN="LEFT" PORT="ref" BGCOLOR="#b8b5b0">
96+
<TD ALIGN="LEFT" PORT="ref" BGCOLOR="#e7e2dd">
8797
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
8898
<TR>
8999
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">ref</FONT></TD>
@@ -93,7 +103,7 @@ Relationships"
93103
</TD>
94104
</TR>
95105
<TR>
96-
<TD ALIGN="LEFT" PORT="revocations" BGCOLOR="#e7e2dd">
106+
<TD ALIGN="LEFT" PORT="revocations" BGCOLOR="#b8b5b0">
97107
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
98108
<TR>
99109
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">revocations</FONT></TD>
@@ -103,7 +113,7 @@ Relationships"
103113
</TD>
104114
</TR>
105115
<TR>
106-
<TD ALIGN="LEFT" PORT="parameters" BGCOLOR="#b8b5b0">
116+
<TD ALIGN="LEFT" PORT="parameters" BGCOLOR="#e7e2dd">
107117
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
108118
<TR>
109119
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">parameters</FONT></TD>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ New versions of this document may be published by:
197197
| --- | --- |
198198
| License | This document is licensed under [CC-BY-4.0] |
199199
| Created | 2024-12-27 |
200-
| Modified | 2025-08-19 |
200+
| Modified | 2025-09-08 |
201201
| Authors | Alex Pozhylenkov <alex.pozhylenkov@iohk.io> |
202202
| | Nathan Bogale <nathan.bogale@iohk.io> |
203203
| | Neil McAuliffe <neil.mcauliffe@iohk.io> |

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ New versions of this document may be published by:
133133
| --- | --- |
134134
| License | This document is licensed under [CC-BY-4.0] |
135135
| Created | 2024-12-27 |
136-
| Modified | 2025-08-19 |
136+
| Modified | 2025-09-08 |
137137
| Authors | Alex Pozhylenkov <alex.pozhylenkov@iohk.io> |
138138
| | Nathan Bogale <nathan.bogale@iohk.io> |
139139
| | Neil McAuliffe <neil.mcauliffe@iohk.io> |

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ New versions of this document may be published by:
226226
| --- | --- |
227227
| License | This document is licensed under [CC-BY-4.0] |
228228
| Created | 2024-12-27 |
229-
| Modified | 2025-08-19 |
229+
| Modified | 2025-09-08 |
230230
| Authors | Alex Pozhylenkov <alex.pozhylenkov@iohk.io> |
231231
| | Nathan Bogale <nathan.bogale@iohk.io> |
232232
| | Neil McAuliffe <neil.mcauliffe@iohk.io> |

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ New versions of this document may be published by:
161161
| --- | --- |
162162
| License | This document is licensed under [CC-BY-4.0] |
163163
| Created | 2024-12-27 |
164-
| Modified | 2025-08-19 |
164+
| Modified | 2025-09-08 |
165165
| Authors | Alex Pozhylenkov <alex.pozhylenkov@iohk.io> |
166166
| | Nathan Bogale <nathan.bogale@iohk.io> |
167167
| | Neil McAuliffe <neil.mcauliffe@iohk.io> |

0 commit comments

Comments
 (0)