feat(docs): Specification Update 0.1.0

.config/dictionaries/project.dic

@@ -164,9 +164,11 @@ ltail
 maindbname
 mapref
 markdownlint
+maxsplit
 mdformat
 mdit
 mdlint
+MDLINTS
 mdns
 MEMMAP
 memx
@@ -198,6 +200,7 @@ nolfs
 notadb
 nsec
 nsecs
+nums
 OCSP
 Oleksandr
 oneshot
@@ -253,6 +256,7 @@ retriggering
 ristretto
 rlib
 rngs
+rowname
 rsplit
 rulelist
 RULENAME
@@ -277,6 +281,8 @@ sitedocs
 skiplist
 slotno
 smac
+sourcenote
+sourcenotes
 stevenj
 stringzilla
 subnetwork

.markdownlint.jsonc

@@ -151,7 +151,9 @@
  // MD033/no-inline-html - Inline HTML
  "MD033": {
  // Allowed elements
- "allowed_elements": []
+ "allowed_elements": [
+ "br"
+ ]
  },
  // MD034/no-bare-urls - Bare URL used
  "MD034": true,

Earthfile

@@ -1,9 +1,9 @@
 VERSION 0.8
 
-IMPORT github.com/input-output-hk/catalyst-ci/earthly/mdlint:v3.4.1 AS mdlint-ci
-IMPORT github.com/input-output-hk/catalyst-ci/earthly/cspell:v3.4.1 AS cspell-ci
-IMPORT github.com/input-output-hk/catalyst-ci/earthly/python:v3.4.1 AS python-ci
-IMPORT github.com/input-output-hk/catalyst-ci:v3.4.1 AS cat-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/mdlint:v3.4.4 AS mdlint-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/cspell:v3.4.4 AS cspell-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/python:v3.4.4 AS python-ci
+IMPORT github.com/input-output-hk/catalyst-ci:v3.4.4 AS cat-ci
 
 FROM debian:stable-slim
 

docs/Earthfile

@@ -1,6 +1,6 @@
 VERSION 0.8
 
-IMPORT github.com/input-output-hk/catalyst-ci/earthly/docs:v3.4.1 AS docs-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/docs:v3.5.1 AS docs-ci
 
 IMPORT .. AS repo
 

docs/mkdocs.yml

@@ -2,7 +2,7 @@ INHERIT: std-theme.yml
 
 # Project Information
 site_name: Project Catalyst - Catalyst Library
-site_url: https://input-output-hk.github.io/catalyst-docs
+site_url: https://input-output-hk.github.io/catalyst-libs
 
 # Repository
 repo_name: input-output-hk/catalyst-libs

docs/src/architecture/08_concepts/catalyst_voting/cddl/Earthfile

@@ -1,6 +1,6 @@
 VERSION 0.8
 
-IMPORT github.com/input-output-hk/catalyst-ci/earthly/cddl:v3.4.1 AS cddl-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/cddl:v3.4.4 AS cddl-ci
 
 check-cddl:
  FROM cddl-ci+cddl-base

docs/src/architecture/08_concepts/immutable_ledger/cddl/Earthfile

@@ -1,6 +1,6 @@
 VERSION 0.8
 
-IMPORT github.com/input-output-hk/catalyst-ci/earthly/cddl:v3.4.1 AS cddl-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/cddl:v3.4.4 AS cddl-ci
 
 check-cddl:
  FROM cddl-ci+cddl-base

docs/src/architecture/08_concepts/signed_doc/.pages

@@ -3,5 +3,7 @@ nav:
  - Specification: spec.md
  - Metadata Fields: metadata.md
  - Document Types: types.md
- - Document Templates: templates.md
  - docs
+ - Document Form Templates: form_templates.md
+ - form_template_elements
+ - Document Presentation Templates: presentation_template.md

docs/src/architecture/08_concepts/signed_doc/cddl/Earthfile

@@ -1,6 +1,6 @@
 VERSION 0.8
 
-IMPORT github.com/input-output-hk/catalyst-ci/earthly/cddl:v3.4.1 AS cddl-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/cddl:v3.4.4 AS cddl-ci
 
 todo-check-cddl:
  FROM cddl-ci+cddl-base

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

@@ -28,6 +28,21 @@ Relationships"
  ];
 
 
+ "Campaign Parameters Form Template" [
+ id="Campaign Parameters Form Template";
+ label=<
+ <TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
+ <TR>
+ <TD PORT="title" BGCOLOR="#1d71b8" HREF="../campaign_parameters_form_template/">
+ <FONT COLOR="#ffffff"><B> Campaign Parameters Form Template </B></FONT>
+ </TD>
+ </TR>
+
+ </TABLE>
+ >
+ ];
+
+
  "Contest Parameters" [
  id="Contest Parameters";
  label=<
@@ -43,13 +58,13 @@ Relationships"
  ];
 
 
- "Proposal" [
- id="Proposal";
+ "Contest Parameters Form Template" [
+ id="Contest Parameters Form Template";
  label=<
  <TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
  <TR>
- <TD PORT="title" BGCOLOR="#1d71b8" HREF="../proposal/">
- <FONT COLOR="#ffffff"><B> Proposal </B></FONT>
+ <TD PORT="title" BGCOLOR="#1d71b8" HREF="../contest_parameters_form_template/">
+ <FONT COLOR="#ffffff"><B> Contest Parameters Form Template </B></FONT>
  </TD>
  </TR>
 
@@ -58,13 +73,13 @@ Relationships"
  ];
 
 
- "Proposal Comment" [
- id="Proposal Comment";
+ "Presentation Template" [
+ id="Presentation Template";
  label=<
  <TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
  <TR>
- <TD PORT="title" BGCOLOR="#1d71b8" HREF="../proposal_comment/">
- <FONT COLOR="#ffffff"><B> Proposal Comment </B></FONT>
+ <TD PORT="title" BGCOLOR="#1d71b8" HREF="../presentation_template/">
+ <FONT COLOR="#ffffff"><B> Presentation Template </B></FONT>
  </TD>
  </TR>
 
@@ -73,13 +88,13 @@ Relationships"
  ];
 
 
- "Proposal Comment Form Template" [
- id="Proposal Comment Form Template";
+ "Proposal" [
+ id="Proposal";
  label=<
  <TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
  <TR>
- <TD PORT="title" BGCOLOR="#1d71b8" HREF="../proposal_comment_form_template/">
- <FONT COLOR="#ffffff"><B> Proposal Comment Form Template </B></FONT>
+ <TD PORT="title" BGCOLOR="#1d71b8" HREF="../proposal/">
+ <FONT COLOR="#ffffff"><B> Proposal </B></FONT>
  </TD>
  </TR>
 
@@ -88,13 +103,13 @@ Relationships"
  ];
 
 
- "Proposal Comment Presentation Template" [
- id="Proposal Comment Presentation Template";
+ "Proposal Comment" [
+ id="Proposal Comment";
  label=<
  <TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
  <TR>
- <TD PORT="title" BGCOLOR="#1d71b8" HREF="../proposal_comment_presentation_template/">
- <FONT COLOR="#ffffff"><B> Proposal Comment Presentation Template </B></FONT>
+ <TD PORT="title" BGCOLOR="#1d71b8" HREF="../proposal_comment/">
+ <FONT COLOR="#ffffff"><B> Proposal Comment </B></FONT>
  </TD>
  </TR>
 
@@ -103,13 +118,13 @@ Relationships"
  ];
 
 
- "Proposal Form Template" [
- id="Proposal Form Template";
+ "Proposal Comment Form Template" [
+ id="Proposal Comment Form Template";
  label=<
  <TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
  <TR>
- <TD PORT="title" BGCOLOR="#1d71b8" HREF="../proposal_form_template/">
- <FONT COLOR="#ffffff"><B> Proposal Form Template </B></FONT>
+ <TD PORT="title" BGCOLOR="#1d71b8" HREF="../proposal_comment_form_template/">
+ <FONT COLOR="#ffffff"><B> Proposal Comment Form Template </B></FONT>
  </TD>
  </TR>
 
@@ -118,13 +133,13 @@ Relationships"
  ];
 
 
- "Proposal Presentation Template" [
- id="Proposal Presentation Template";
+ "Proposal Form Template" [
+ id="Proposal Form Template";
  label=<
  <TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
  <TR>
- <TD PORT="title" BGCOLOR="#1d71b8" HREF="../proposal_presentation_template/">
- <FONT COLOR="#ffffff"><B> Proposal Presentation Template </B></FONT>
+ <TD PORT="title" BGCOLOR="#1d71b8" HREF="../proposal_form_template/">
+ <FONT COLOR="#ffffff"><B> Proposal Form Template </B></FONT>
  </TD>
  </TR>
 
@@ -207,7 +222,7 @@ Relationships"
  <TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
  <TR>
  <TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">type</FONT></TD>
- <TD ALIGN="RIGHT"><FONT FACE="Courier" COLOR="#7706E5"><B><I>60185874-7e13-407c-a06c-238ffe637ae6<BR />ebcabeeb-5bc5-4f95-91e8-cab8ca724172</I></B></FONT></TD>
+ <TD ALIGN="RIGHT"><FONT FACE="Courier" COLOR="#7706E5"><B><I>3e4808cc-c86e-467b-9702-d60baa9d1fca</I></B></FONT></TD>
  </TR>
  </TABLE>
  </TD>
@@ -286,13 +301,14 @@ Relationships"
 
  "Brand Parameters":"template":e -> "Brand Parameters Form Template":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
  "Campaign Parameters":"title":e -> "Brand Parameters":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
+ "Campaign Parameters Form Template":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
  "Contest Parameters":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
+ "Contest Parameters Form Template":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
+ "Presentation Template":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
  "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 Form Template":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
- "Proposal Comment Presentation Template":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
  "Proposal Form Template":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
- "Proposal Presentation Template":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
  "Proposal Submission Action":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
  "Rep Profile":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
  "Rep Profile Form Template":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]

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

@@ -37,7 +37,7 @@ Document Relationships"
  <TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
  <TR>
  <TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">type</FONT></TD>
- <TD ALIGN="RIGHT"><FONT FACE="Courier" COLOR="#7706E5"><B><I>0ce8ab38-9258-4fbc-a62e-7faa6e58318f<BR />60185874-7e13-407c-a06c-238ffe637ae6<BR />ebcabeeb-5bc5-4f95-91e8-cab8ca724172</I></B></FONT></TD>
+ <TD ALIGN="RIGHT"><FONT FACE="Courier" COLOR="#7706E5"><B><I>fd3c1735-80b1-4eea-8d63-5f436d97ea31</I></B></FONT></TD>
  </TR>
  </TABLE>
  </TD>