feat(docs): Specification Update 0.1.0 (#408)

* feat(docs): Seperate the field element dictionary from the base template

* docs(docs): Add an examples to the example schema

* feat(docs): Generate Form Template specifications

* fix(docs): Base documentation site url.

* fix(docs): Fix the document index

* fix(docs): add placeholder doc until form elements docs are generated

* feat(docs): Form Element Documentation (#419)

* feat(docs): Autogenerate the element dictionary and ref the element docs

* fix(docs): spec.md headers formatting

* fix(docs): dont use inline html

* fix(docs): CI

* fix(docs): spelling

* fix(docs): Generate spec.md from its template

* feat(docs): add capability to link to a heading in a doc

* fix(docs): remove experimental mdformat code (not formatted how we need, and not configurable.)

* feat(docs): Generate .pages from template

* fix(docs): don't need filename with template of same name

* feat(docs): Generate types.md from template

* feat(docs): Generate the metadata.md file from a template

* feat(docs): Generate docs for each of the doc pages using templates

* feat(docs): generalize inter page link generation

* feat(docs): First genersation of form element documentation

* feat(docs): wip for element parameters docs

* feat(docs): Control icon assets with the specifications

* fix(docs): cleanup how we document available icons

* docs(docs): element parameters updates WIP

* feat(docs): Autogenerates the example schema for form elements correctly

* fix(docs): re-order the form template specs to match the schema

* feat(docs): Add examples and better docs for Multiline text entry

* feat(docs): fully document all elements except the tag selector

* feat(docs): Revert document type to a single UUIDv4

* docs(docs): Mark proposal moderation actions as speculative

* fix(docs): Cleanup drep nomination/delegation descriptions around revocation.

* feat(docs): make doc generation heirarchial and cleanup status display

* feat(docs): add regex for form names and title case names

* feat(docs): Create a module that holds all the doc types for easier re-use between modules

* feat(docs): Change the signed docs defs to use the doct type module

* fix(docs): format

* feat(docs): first version of the presentation template specs - data only

* feat(docs): draft business logic pages - not rendered

* feat(docs): add initial red delegation flows

* feat(docs): presentation templates wip

* feat(docs): draft version of the presentation template docs

* fix(docs): markdown lint issues

* fix(docs): Template refrences to parameters, and changes

* fix(docs): Submission action schema fixup for 2020-12, and add authors

* fix(docs): Add icon def to changes for latest version

\

* docs(docs): Something wrong with document overview

* fix(docs): Fix generating and displaying the signed doc heirarchy

Author: stevenj

.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