Skip to content

Commit 737a649

Browse files
stevenjstevenj
authored
feat(docs): Consolidate all parameters types into a single parameters reference. (#303)
* feat(docs): Consolidate all parameters types into a single parameters reference. * fix(docs): Fix linked references * feat(docs): Start of adding capability to cluster like documents to simplify relationship diagrams. * fix(docs): wip fix of clustered documents * feat(docs): Add document clusters to help with autogenerated diagrams. * fix(docs): fix spelling * fix(Python): fix type * fix(docs): Inter doc links in diagrams * fix(docs): Neils Eyesight Soother * fix(docs): Rename Election Parameters to Decision parameters
1 parent 2008c9c commit 737a649

Some content is hidden

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

61 files changed

+2398
-2708
lines changed

‎.config/dictionaries/project.dic

+2
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,7 @@ labelloc
142142
lcov
143143
Leay
144144
Leshiy
145+
lhead
145146
libipld
146147
libp2p
147148
libsqlite
@@ -155,6 +156,7 @@ livedocs
155156
localizable
156157
logcall
157158
lookaside
159+
ltail
158160
maindbname
159161
mapref
160162
markdownlint

‎docs/src/architecture/08_concepts/signed_doc/cddl/signed_document.cddl

+2-6
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,8 @@ Signed_Document_Metadata_Headers = (
6262
?"section" => section_ref
6363
?"collaborators" => collaborators
6464
?"revocations" => revocations
65-
?"election_id" => document_ref
66-
? (
67-
"brand_id" => document_ref //
68-
"campaign_id" => document_ref //
69-
"category_id" => document_ref
70-
))
65+
?"parameters" => document_ref
66+
)
7167

7268
; Document Type
7369
document_type = [ 1* uuid_v4 ]

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

+341-443
Large diffs are not rendered by default.

‎docs/src/architecture/08_concepts/signed_doc/diagrams/brand_parameters.dot

+127-71
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,116 @@
11
digraph "Brand Parameters" {
22
rankdir="LR"
3-
graph [fontname="helvetica", fontsize="32", fontcolor="#29235c", bgcolor="white"];
4-
node [penwidth="0", margin="0", fontname="helvetica", fontsize="32", fontcolor="#29235c"];
5-
edge [fontname="helvetica", fontsize="32", fontcolor="red", color="#29235c"];
3+
graph [fontname="helvetica", fontsize="32", fontcolor="#29235c", bgcolor="white"];
4+
node [penwidth="0", margin="0", fontname="helvetica", fontsize="32", fontcolor="#29235c"];
5+
edge [fontname="helvetica", fontsize="32", fontcolor="red", color="#29235c"];
66

77
labelloc="t"
88
label="Brand Parameters Document
99
Relationships"
1010
fontcolor="#1d71b8"
1111
fontsize=50
12-
13-
14-
"Brand Parameters" [
15-
id="Brand Parameters";
12+
compound=true
13+
14+
15+
16+
subgraph cluster_system_parameters {
17+
label = "System Parameters";
18+
color=blue
19+
penwidth=20
20+
21+
"Brand Parameters" [
22+
id="Brand Parameters";
23+
label=<
24+
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
25+
<TR>
26+
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../brand_parameters/">
27+
<FONT COLOR="#ffffff"><B> Brand Parameters </B></FONT>
28+
</TD>
29+
</TR>
30+
<TR>
31+
<TD ALIGN="LEFT" PORT="content type" BGCOLOR="#e7e2dd">
32+
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
33+
<TR>
34+
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">content type</FONT></TD>
35+
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>application/json</I></FONT></TD>
36+
</TR>
37+
</TABLE>
38+
</TD>
39+
</TR>
40+
<TR>
41+
<TD ALIGN="LEFT" PORT="type" BGCOLOR="#b8b5b0">
42+
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
43+
<TR>
44+
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">type</FONT></TD>
45+
<TD ALIGN="RIGHT"><FONT FACE="Courier" COLOR="#7706E5"><B><I>ebcabeeb-5bc5-4f95-91e8-cab8ca724172</I></B></FONT></TD>
46+
</TR>
47+
</TABLE>
48+
</TD>
49+
</TR>
50+
<TR>
51+
<TD ALIGN="LEFT" PORT="id" BGCOLOR="#e7e2dd">
52+
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
53+
<TR>
54+
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">id</FONT></TD>
55+
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Document Id</I></FONT></TD>
56+
</TR>
57+
</TABLE>
58+
</TD>
59+
</TR>
60+
<TR>
61+
<TD ALIGN="LEFT" PORT="ver" BGCOLOR="#b8b5b0">
62+
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
63+
<TR>
64+
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">ver</FONT></TD>
65+
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Document Ver</I></FONT></TD>
66+
</TR>
67+
</TABLE>
68+
</TD>
69+
</TR>
70+
71+
</TABLE>
72+
>
73+
];
74+
75+
76+
"Campaign Parameters" [
77+
id="Campaign Parameters";
78+
label=<
79+
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
80+
<TR>
81+
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../campaign_parameters/">
82+
<FONT COLOR="#ffffff"><B> Campaign Parameters </B></FONT>
83+
</TD>
84+
</TR>
85+
86+
</TABLE>
87+
>
88+
];
89+
90+
}
91+
92+
"Decision Parameters" [
93+
id="Decision Parameters";
1694
label=<
1795
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
1896
<TR>
19-
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../brand_parameters/">
20-
<FONT COLOR="#ffffff"><B> Brand Parameters </B></FONT>
21-
</TD>
22-
</TR>
23-
<TR>
24-
<TD ALIGN="LEFT" PORT="content type" BGCOLOR="#e7e2dd">
25-
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
26-
<TR>
27-
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT>content type</FONT></TD>
28-
<TD ALIGN="RIGHT"><FONT><I>application/json</I></FONT></TD>
29-
</TR>
30-
</TABLE>
31-
</TD>
32-
</TR>
33-
<TR>
34-
<TD ALIGN="LEFT" PORT="type" BGCOLOR="#b8b5b0">
35-
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
36-
<TR>
37-
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT>type</FONT></TD>
38-
<TD ALIGN="RIGHT"><FONT FACE="Courier"><I>ebcabeeb-5bc5-4f95-91e8-cab8ca724172</I></FONT></TD>
39-
</TR>
40-
</TABLE>
41-
</TD>
42-
</TR>
43-
<TR>
44-
<TD ALIGN="LEFT" PORT="id" BGCOLOR="#e7e2dd">
45-
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
46-
<TR>
47-
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT>id</FONT></TD>
48-
<TD ALIGN="RIGHT"><FONT><I>Document Id</I></FONT></TD>
49-
</TR>
50-
</TABLE>
97+
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../decision_parameters/">
98+
<FONT COLOR="#ffffff"><B> Decision Parameters </B></FONT>
5199
</TD>
52100
</TR>
101+
102+
</TABLE>
103+
>
104+
];
105+
106+
107+
"Proposal" [
108+
id="Proposal";
109+
label=<
110+
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
53111
<TR>
54-
<TD ALIGN="LEFT" PORT="ver" BGCOLOR="#b8b5b0">
55-
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
56-
<TR>
57-
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT>ver</FONT></TD>
58-
<TD ALIGN="RIGHT"><FONT><I>Document Ver</I></FONT></TD>
59-
</TR>
60-
</TABLE>
112+
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../proposal/">
113+
<FONT COLOR="#ffffff"><B> Proposal </B></FONT>
61114
</TD>
62115
</TR>
63116

@@ -66,13 +119,13 @@ Relationships"
66119
];
67120

68121

69-
"Campaign Parameters" [
70-
id="Campaign Parameters";
122+
"Proposal Comment" [
123+
id="Proposal Comment";
71124
label=<
72125
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
73126
<TR>
74-
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../campaign_parameters/">
75-
<FONT COLOR="#ffffff"><B> Campaign Parameters </B></FONT>
127+
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../proposal_comment/">
128+
<FONT COLOR="#ffffff"><B> Proposal Comment </B></FONT>
76129
</TD>
77130
</TR>
78131

@@ -81,13 +134,13 @@ Relationships"
81134
];
82135

83136

84-
"Election Parameters" [
85-
id="Election Parameters";
137+
"Proposal Comment Meta Template" [
138+
id="Proposal Comment Meta Template";
86139
label=<
87140
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
88141
<TR>
89-
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../election_parameters/">
90-
<FONT COLOR="#ffffff"><B> Election Parameters </B></FONT>
142+
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../proposal_comment_meta_template/">
143+
<FONT COLOR="#ffffff"><B> Proposal Comment Meta Template </B></FONT>
91144
</TD>
92145
</TR>
93146

@@ -96,13 +149,13 @@ Relationships"
96149
];
97150

98151

99-
"Proposal" [
100-
id="Proposal";
152+
"Proposal Comment Template" [
153+
id="Proposal Comment Template";
101154
label=<
102155
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
103156
<TR>
104-
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../proposal/">
105-
<FONT COLOR="#ffffff"><B> Proposal </B></FONT>
157+
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../proposal_comment_template/">
158+
<FONT COLOR="#ffffff"><B> Proposal Comment Template </B></FONT>
106159
</TD>
107160
</TR>
108161

@@ -111,13 +164,13 @@ Relationships"
111164
];
112165

113166

114-
"Proposal Comment" [
115-
id="Proposal Comment";
167+
"Proposal Meta Template" [
168+
id="Proposal Meta Template";
116169
label=<
117170
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
118171
<TR>
119-
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../proposal_comment/">
120-
<FONT COLOR="#ffffff"><B> Proposal Comment </B></FONT>
172+
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../proposal_meta_template/">
173+
<FONT COLOR="#ffffff"><B> Proposal Meta Template </B></FONT>
121174
</TD>
122175
</TR>
123176

@@ -126,13 +179,13 @@ Relationships"
126179
];
127180

128181

129-
"Proposal Comment Template" [
130-
id="Proposal Comment Template";
182+
"Proposal Submission Action" [
183+
id="Proposal Submission Action";
131184
label=<
132185
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
133186
<TR>
134-
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../proposal_comment_template/">
135-
<FONT COLOR="#ffffff"><B> Proposal Comment Template </B></FONT>
187+
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../proposal_submission_action/">
188+
<FONT COLOR="#ffffff"><B> Proposal Submission Action </B></FONT>
136189
</TD>
137190
</TR>
138191

@@ -157,9 +210,12 @@ Relationships"
157210

158211

159212
"Campaign Parameters":"title":e -> "Brand Parameters":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
160-
"Election Parameters":"title":e -> "Brand Parameters":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
161-
"Proposal":"title":e -> "Brand Parameters":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
162-
"Proposal Comment":"title":e -> "Brand Parameters":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
163-
"Proposal Comment Template":"title":e -> "Brand Parameters":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
164-
"Proposal Template":"title":e -> "Brand Parameters":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
213+
"Decision Parameters":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
214+
"Proposal":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
215+
"Proposal Comment":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
216+
"Proposal Comment Meta Template":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
217+
"Proposal Comment Template":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
218+
"Proposal Meta Template":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
219+
"Proposal Submission Action":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
220+
"Proposal Template":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
165221
}

0 commit comments

Comments
 (0)