fix(docs): Validation of docs generation in CI (#272)

* fix(docs): Validation of docs generation in CI

* fix(docs): remove test code from docs earthfile

* fix(docs): regenerate image with latest stable d2

Author: stevenj

.config/dictionaries/project.dic

@@ -90,6 +90,7 @@ fmmap
 fmtchk
 fmtfix
 fontawesome
+fromfiledate
 fsgr
 fstat
 fstatat
@@ -134,6 +135,7 @@ libp2p
 libsqlite
 libssh
 libtest
+lineterm
 linkat
 lintfix
 lipsum
@@ -260,6 +262,8 @@ timelike
 timespec
 tinygo
 tinyvec
+tofile
+tofiledate
 toobig
 toolsets
 Traceback

docs/Earthfile

@@ -4,7 +4,6 @@ IMPORT github.com/input-output-hk/catalyst-ci/earthly/docs:v3.3.0 AS docs-ci
 
 
 IMPORT .. AS repo
-IMPORT ../specs AS specs
 
 # Copy all the source we need to build the docs
 src:
@@ -14,8 +13,12 @@ src:
     # Now copy into that any artifacts we pull from the builds.
     COPY --dir repo+repo-docs/repo /docs/includes
 
-    # Copy our generated Signed Document Specification data.
-    COPY specs+src/signed_doc.json /docs/includes
+# Save a copy of the generated doc pages, so they can be validated.
+# These need to be in-sync with the signed docs specification data.
+generated-signed-docs-pages:
+    FROM +src
+
+    SAVE ARTIFACT src/architecture/08_concepts/signed_doc signed_doc
 
 
 # Build the docs here.

docs/src/architecture/08_concepts/signed_doc/doc_relationships.d2

@@ -18,10 +18,19 @@ copyright: |~md
 | --- | --- |
 | License | This document is licensed under CC-BY-4.0 |
 | Created | 2024-12-27 |
-| Modified | 2025-04-04 |
+| Modified | 2025-04-09 |
 | Authors | Alex Pozhylenkov <[email protected]> |
 | | Steven Johnson <[email protected]> |
 
+### Changelog
+
+#### 0.01 (2025-04-04)
+
+* First Published Version
+
+#### 0.02 (2025-04-09)
+
+* Add version control changelogs to the specification.
 ~|  {near: bottom-right}
 
 "Brand Parameters": {
@@ -57,7 +66,7 @@ copyright: |~md
 
 
 
-"Comment Action Document": {
+"Comment Moderation Action": {
   shape: sql_table
   "content type": application/json
   "type [0]": 5e60e623-ad02-4a1b-a1ac-406db978ee48

docs/src/architecture/08_concepts/signed_doc/doc_relationships.svg

@@ -100,10 +100,16 @@ New versions of this document may be published by:
 | --- | --- |
 | License | This document is licensed under [CC-BY-4.0] |
 | Created | 2024-12-27 |
-| Modified | 2025-04-04 |
+| Modified | 2025-04-09 |
 | Authors | Alex Pozhylenkov <[email protected]> |
 | | Steven Johnson <[email protected]> |
 
+### Changelog
+
+#### 0.01 (2025-04-04)
+
+* First Published Version
+
 [RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1
 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7

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

@@ -100,10 +100,16 @@ New versions of this document may be published by:
 | --- | --- |
 | License | This document is licensed under [CC-BY-4.0] |
 | Created | 2024-12-27 |
-| Modified | 2025-04-04 |
+| Modified | 2025-04-09 |
 | Authors | Alex Pozhylenkov <[email protected]> |
 | | Steven Johnson <[email protected]> |
 
+### Changelog
+
+#### 0.01 (2025-04-04)
+
+* First Published Version
+
 [RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1
 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7

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

@@ -100,10 +100,16 @@ New versions of this document may be published by:
 | --- | --- |
 | License | This document is licensed under [CC-BY-4.0] |
 | Created | 2024-12-27 |
-| Modified | 2025-04-04 |
+| Modified | 2025-04-09 |
 | Authors | Alex Pozhylenkov <[email protected]> |
 | | Steven Johnson <[email protected]> |
 
+### Changelog
+
+#### 0.01 (2025-04-04)
+
+* First Published Version
+
 [RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1
 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7

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

@@ -1,11 +1,11 @@
-# Comment Action Document
+# Comment Moderation Action
 
 ## Description
 
 TODO
 
 ```d2 layout="elk"
-"Comment Action Document": {
+"Comment Moderation Action": {
   shape: sql_table
   "content type": application/json
   "type [0]": 5e60e623-ad02-4a1b-a1ac-406db978ee48
@@ -102,10 +102,16 @@ New versions of this document may be published by:
 | --- | --- |
 | License | This document is licensed under [CC-BY-4.0] |
 | Created | 2024-12-27 |
-| Modified | 2025-04-04 |
+| Modified | 2025-04-09 |
 | Authors | Alex Pozhylenkov <[email protected]> |
 | | Steven Johnson <[email protected]> |
 
+### Changelog
+
+#### 0.01 (2025-04-04)
+
+* First Published Version
+
 [RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1
 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7

…gned_doc/docs/comment_action_document.md …ed_doc/docs/comment_moderation_action.mddocs/src/architecture/08_concepts/signed_doc/docs/comment_action_document.md renamed to docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md docs/src/architecture/08_concepts/signed_doc/docs/comment_action_document.md renamed to docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md

@@ -100,10 +100,16 @@ New versions of this document may be published by:
 | --- | --- |
 | License | This document is licensed under [CC-BY-4.0] |
 | Created | 2024-12-27 |
-| Modified | 2025-04-04 |
+| Modified | 2025-04-09 |
 | Authors | Alex Pozhylenkov <[email protected]> |
 | | Steven Johnson <[email protected]> |
 
+### Changelog
+
+#### 0.01 (2025-04-04)
+
+* First Published Version
+
 [RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1
 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7

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

@@ -174,10 +174,16 @@ New versions of this document may be published by:
 | --- | --- |
 | License | This document is licensed under [CC-BY-4.0] |
 | Created | 2024-12-27 |
-| Modified | 2025-04-04 |
+| Modified | 2025-04-09 |
 | Authors | Alex Pozhylenkov <[email protected]> |
 | | Steven Johnson <[email protected]> |
 
+### Changelog
+
+#### 0.01 (2025-04-04)
+
+* First Published Version
+
 [RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1
 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7