Skip to content

fix(docs): system parameters schema and cue definition #335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 14 commits into
base: feat/signed-doc-spec-0.04
Choose a base branch
from
Open

fix(docs): system parameters schema and cue definition #335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
15683fa
fix(docs): system parameters schema and cue definition
nathanbogale May 19, 2025
58e1be5
fix(docs): parameter json and cue structure
nathanbogale May 19, 2025
04d8238
fix (docs): decision reference to brand and overall structure
nathanbogale May 19, 2025
cb28dec
fix(docs): cue files fixed - path wip
nathanbogale May 19, 2025
f1ae914
fix(docs): fixed instabilities with the signed document generation
nathanbogale May 20, 2025
4973d39
feat(docs): Add examples for predefined document schemas
stevenj May 20, 2025
fb6b392
Merge branch 'main' into feat/add-payload-examples
stevenj May 20, 2025
e2d902d
Merge branch 'feat/signed-doc-spec-0.04' into feat/add-payload-examples
stevenj May 20, 2025
9feb9a5
Merge branch 'feat/signed-doc-spec-0.04' into feat/system-parameters
stevenj May 21, 2025
757c07a
Merge branch 'feat/add-payload-examples' into feat/system-parameters
nathanbogale May 21, 2025
aae4675
fix(docs): stable document regeneration
nathanbogale May 21, 2025
0023a5e
fix(docs): schema and example updated and stable for brands, campaign…
nathanbogale May 22, 2025
2bc1917
fix(docs): added a central and reusable definition json for schema re…
nathanbogale May 26, 2025
eff33eb
fix(docs): updated template reference and usage
nathanbogale Jun 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,9 @@ $RECYCLE.BIN/
!/.vscode/settings.recommended.json
!/.vscode/tasks.recommended.json

venv/
# Python virtual environments

# Dart stuff
/pubspec.lock
/.dart_tool/**/*
Expand Down
53 changes: 47 additions & 6 deletions docs/src/architecture/08_concepts/signed_doc/diagrams/all.dot
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,26 @@ digraph "All" {
</TABLE>
</TD>
</TR>
<TR>
<TD ALIGN="LEFT" PORT="collaborators" BGCOLOR="#e7e2dd">
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
<TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">collaborators</FONT></TD>
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Collaborators Reference List</I></FONT></TD>
</TR>
</TABLE>
</TD>
</TR>
<TR>
<TD ALIGN="LEFT" PORT="parameters" BGCOLOR="#b8b5b0">
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
<TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">parameters</FONT></TD>
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Brand Parameters</I></FONT></TD>
</TR>
</TABLE>
</TD>
</TR>

</TABLE>
>
Expand Down Expand Up @@ -122,11 +142,21 @@ digraph "All" {
</TD>
</TR>
<TR>
<TD ALIGN="LEFT" PORT="parameters" BGCOLOR="#e7e2dd">
<TD ALIGN="LEFT" PORT="collaborators" BGCOLOR="#e7e2dd">
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
<TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">collaborators</FONT></TD>
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Collaborators Reference List</I></FONT></TD>
</TR>
</TABLE>
</TD>
</TR>
<TR>
<TD ALIGN="LEFT" PORT="parameters" BGCOLOR="#b8b5b0">
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
<TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">parameters</FONT></TD>
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Brand Parameters</I></FONT></TD>
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Campaign Parameters</I></FONT></TD>
</TR>
</TABLE>
</TD>
Expand Down Expand Up @@ -187,7 +217,17 @@ digraph "All" {
</TD>
</TR>
<TR>
<TD ALIGN="LEFT" PORT="parameters" BGCOLOR="#e7e2dd">
<TD ALIGN="LEFT" PORT="collaborators" BGCOLOR="#e7e2dd">
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
<TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">collaborators</FONT></TD>
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Collaborators Reference List</I></FONT></TD>
</TR>
</TABLE>
</TD>
</TR>
<TR>
<TD ALIGN="LEFT" PORT="parameters" BGCOLOR="#b8b5b0">
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
<TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">parameters</FONT></TD>
Expand Down Expand Up @@ -437,7 +477,7 @@ digraph "All" {
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
<TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">parameters</FONT></TD>
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Brand Parameters<BR />Campaign Parameters<BR />Category Parameters</I></FONT></TD>
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Decision Parameters</I></FONT></TD>
</TR>
</TABLE>
</TD>
Expand Down Expand Up @@ -963,10 +1003,11 @@ digraph "All" {
];


"Campaign Parameters":"parameters":e -> "Brand Parameters":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
"Brand Parameters":"parameters":e -> "Brand Parameters":"title":n [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
"Campaign Parameters":"parameters":e -> "Campaign Parameters":"title":n [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
"Category Parameters":"parameters":e -> "Campaign Parameters":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
"Comment Moderation Action":"ref":e -> "Proposal Comment":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
"Decision Parameters":"parameters":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
"Decision Parameters":"parameters":e -> "Decision Parameters":"title":n [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
"Proposal":"template":e -> "Proposal Template":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
"Proposal":"parameters":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
"Proposal Comment":"ref":e -> "Proposal":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
Expand Down
47 changes: 18 additions & 29 deletions docs/src/architecture/08_concepts/signed_doc/diagrams/brand_parameters.dot
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,19 +67,24 @@ Relationships"
</TABLE>
</TD>
</TR>

</TABLE>
>
];


"Campaign Parameters" [
id="Campaign Parameters";
label=<
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
<TR>
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../campaign_parameters/">
<FONT COLOR="#ffffff"><B> Campaign Parameters </B></FONT>
<TD ALIGN="LEFT" PORT="collaborators" BGCOLOR="#e7e2dd">
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
<TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">collaborators</FONT></TD>
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Collaborators Reference List</I></FONT></TD>
</TR>
</TABLE>
</TD>
</TR>
<TR>
<TD ALIGN="LEFT" PORT="parameters" BGCOLOR="#b8b5b0">
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
<TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">parameters</FONT></TD>
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Brand Parameters</I></FONT></TD>
</TR>
</TABLE>
</TD>
</TR>

Expand All @@ -89,21 +94,6 @@ Relationships"

}

"Decision Parameters" [
id="Decision Parameters";
label=<
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
<TR>
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../decision_parameters/">
<FONT COLOR="#ffffff"><B> Decision Parameters </B></FONT>
</TD>
</TR>

</TABLE>
>
];


"Proposal" [
id="Proposal";
label=<
Expand Down Expand Up @@ -209,8 +199,7 @@ Relationships"
];


"Campaign Parameters":"title":e -> "Brand Parameters":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
"Decision Parameters":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
"Brand Parameters":"parameters":e -> "Brand Parameters":"title":n [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
"Proposal":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
"Proposal Comment":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
"Proposal Comment Meta Template":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
Expand Down
47 changes: 13 additions & 34 deletions docs/src/architecture/08_concepts/signed_doc/diagrams/campaign_parameters.dot
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,6 @@ Relationships"
color=blue
penwidth=20

"Brand Parameters" [
id="Brand Parameters";
label=<
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
<TR>
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../brand_parameters/">
<FONT COLOR="#ffffff"><B> Brand Parameters </B></FONT>
</TD>
</TR>

</TABLE>
>
];


"Campaign Parameters" [
id="Campaign Parameters";
label=<
Expand Down Expand Up @@ -83,11 +68,21 @@ Relationships"
</TD>
</TR>
<TR>
<TD ALIGN="LEFT" PORT="parameters" BGCOLOR="#e7e2dd">
<TD ALIGN="LEFT" PORT="collaborators" BGCOLOR="#e7e2dd">
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
<TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">collaborators</FONT></TD>
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Collaborators Reference List</I></FONT></TD>
</TR>
</TABLE>
</TD>
</TR>
<TR>
<TD ALIGN="LEFT" PORT="parameters" BGCOLOR="#b8b5b0">
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
<TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">parameters</FONT></TD>
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Brand Parameters</I></FONT></TD>
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Campaign Parameters</I></FONT></TD>
</TR>
</TABLE>
</TD>
Expand All @@ -114,21 +109,6 @@ Relationships"

}

"Decision Parameters" [
id="Decision Parameters";
label=<
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
<TR>
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../decision_parameters/">
<FONT COLOR="#ffffff"><B> Decision Parameters </B></FONT>
</TD>
</TR>

</TABLE>
>
];


"Proposal" [
id="Proposal";
label=<
Expand Down Expand Up @@ -234,9 +214,8 @@ Relationships"
];


"Campaign Parameters":"parameters":e -> "Brand Parameters":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
"Campaign Parameters":"parameters":e -> "Campaign Parameters":"title":n [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
"Category Parameters":"title":e -> "Campaign Parameters":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
"Decision Parameters":"title":e -> "Campaign Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
"Proposal":"title":e -> "Campaign Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
"Proposal Comment":"title":e -> "Campaign Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
"Proposal Comment Meta Template":"title":e -> "Campaign Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
Expand Down
28 changes: 11 additions & 17 deletions docs/src/architecture/08_concepts/signed_doc/diagrams/category_parameters.dot
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,17 @@ Relationships"
</TD>
</TR>
<TR>
<TD ALIGN="LEFT" PORT="parameters" BGCOLOR="#e7e2dd">
<TD ALIGN="LEFT" PORT="collaborators" BGCOLOR="#e7e2dd">
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
<TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">collaborators</FONT></TD>
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Collaborators Reference List</I></FONT></TD>
</TR>
</TABLE>
</TD>
</TR>
<TR>
<TD ALIGN="LEFT" PORT="parameters" BGCOLOR="#b8b5b0">
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
<TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">parameters</FONT></TD>
Expand All @@ -99,21 +109,6 @@ Relationships"

}

"Decision Parameters" [
id="Decision Parameters";
label=<
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
<TR>
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../decision_parameters/">
<FONT COLOR="#ffffff"><B> Decision Parameters </B></FONT>
</TD>
</TR>

</TABLE>
>
];


"Proposal" [
id="Proposal";
label=<
Expand Down Expand Up @@ -220,7 +215,6 @@ Relationships"


"Category Parameters":"parameters":e -> "Campaign Parameters":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
"Decision Parameters":"title":e -> "Category Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
"Proposal":"title":e -> "Category Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
"Proposal Comment":"title":e -> "Category Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
"Proposal Comment Meta Template":"title":e -> "Category Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
Expand Down
55 changes: 2 additions & 53 deletions docs/src/architecture/08_concepts/signed_doc/diagrams/decision_parameters.dot
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,57 +13,6 @@ Relationships"



subgraph cluster_system_parameters {
label = "System Parameters";
color=blue
penwidth=20

"Brand Parameters" [
id="Brand Parameters";
label=<
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
<TR>
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../brand_parameters/">
<FONT COLOR="#ffffff"><B> Brand Parameters </B></FONT>
</TD>
</TR>

</TABLE>
>
];


"Campaign Parameters" [
id="Campaign Parameters";
label=<
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
<TR>
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../campaign_parameters/">
<FONT COLOR="#ffffff"><B> Campaign Parameters </B></FONT>
</TD>
</TR>

</TABLE>
>
];


"Category Parameters" [
id="Category Parameters";
label=<
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
<TR>
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../category_parameters/">
<FONT COLOR="#ffffff"><B> Category Parameters </B></FONT>
</TD>
</TR>

</TABLE>
>
];

}

"Decision Parameters" [
id="Decision Parameters";
label=<
Expand Down Expand Up @@ -118,7 +67,7 @@ Relationships"
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
<TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">parameters</FONT></TD>
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Brand Parameters<BR />Campaign Parameters<BR />Category Parameters</I></FONT></TD>
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Decision Parameters</I></FONT></TD>
</TR>
</TABLE>
</TD>
Expand All @@ -129,5 +78,5 @@ Relationships"
];


"Decision Parameters":"parameters":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
"Decision Parameters":"parameters":e -> "Decision Parameters":"title":n [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
}
Loading
Loading