feat: add doc (#9)

* feat: copy docs from cat-voice * fix: docs * fix: md lint * fix: delete unnecessary stuff * fix: spelling * fix: disable md004 * fix: intro * feat: add chain follower
input-output-hk · Aug 29, 2024 · 0de3232 · 0de3232
1 parent 920595c
commit 0de3232
Show file tree

Hide file tree

Showing 96 changed files with 13,547 additions and 2 deletions.
diff --git a/.config/dictionaries/project.dic b/.config/dictionaries/project.dic
@@ -50,6 +50,7 @@ DBSTATUS
 dbsync
 dcbor
 delegators
+Dominik
 dockerhub
 dotenv
 dotenvy
@@ -59,6 +60,7 @@ dreps
 earthfile
 Earthfile
 encryptor
+Eternl
 Errno
 excalidraw
 fadvise
@@ -117,6 +119,8 @@ localizable
 lookaside
 maindbname
 mapref
+Metadatum
+metadatum
 mdlint
 mdns
 minicbor
@@ -138,6 +142,7 @@ nolfs
 notadb
 nsec
 OCSP
+Oleksandr
 oneshot
 openapi
 openat
@@ -157,6 +162,7 @@ preopen
 preopened
 preopens
 preprod
+Prokhorenko
 psql
 pubk
 pubkey
@@ -170,6 +176,7 @@ readlinkat
 redoc
 REMOVEDIR
 renameat
+Replayability
 reqwest
 retriggering
 rlib
@@ -205,6 +212,7 @@ testcase
 testcov
 testdocs
 testunit
+testplan
 thiserror
 timelike
 timespec
@@ -220,8 +228,12 @@ unixfs
 unlinkat
 upnp
 userid
+UTXO
 utimensat
 vitss
+Vkey
+vkey
+vkeywitness
 voteplan
 voteplans
 wasi

diff --git a/docs/.gitkeep b/docs/.gitkeep
diff --git a/docs/Earthfile b/docs/Earthfile
@@ -0,0 +1,30 @@
+VERSION 0.8
+
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/docs:v3.1.21 AS docs-ci
+
+IMPORT .. AS repo
+
+# Copy all the source we need to build the docs
+src:
+    # Common src setup
+    DO docs-ci+SRC
+
+    # Now copy into that any artifacts we pull from the builds.
+    COPY --dir repo+repo-docs/repo /docs/includes
+
+
+# Build the docs here.
+docs:
+    FROM +src
+
+    DO docs-ci+BUILD
+
+# local : Create a local image of the document.
+local:
+    DO docs-ci+PACKAGE
+
+    # Copy the static pages into the container
+    COPY +docs/ /usr/share/nginx/html
+
+    # This is a local only image, we do not publish it.
+    SAVE IMAGE catalyst-libs-docs:latest
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -0,0 +1,45 @@
+INHERIT: std-theme.yml
+
+# Project Information
+site_name: Project Catalyst - Catalyst Library
+site_url: https://input-output-hk.github.io/catalyst-docs
+
+# Repository
+repo_name: input-output-hk/catalyst-libs
+repo_url: https://github.com/input-output-hk/catalyst-libs
+
+# Page tree - is created automatically.
+# See: https://henrywhitaker3.github.io/mkdocs-material-dark-theme/plugins/awesome-pages/
+
+# Tags used in these docs
+extra:
+  tags:
+    HTML5: html
+    JavaScript: js
+    CSS: css
+    Rust: rust
+    Flutter: flutter
+    Dart: dart
+    Python: python
+    Earthly: earthly
+    Github: github
+    Docker: docker
+    arc42: arc42
+    ADR: adr
+
+# Icons associated with the tags
+theme:
+  icon:
+    tag:
+      html: fontawesome/brands/html5
+      js: fontawesome/brands/js
+      css: fontawesome/brands/css3
+      rust: simple/rust
+      flutter: simple/flutter
+      dart: simple/dart
+      python: simple/python
+      earthly: material/earth-plus
+      github: simple/github
+      docker: simple/docker
+      arc42: material/pencil-ruler
+      adr: material/arrow-decision-auto
diff --git a/docs/src/.pages b/docs/src/.pages
@@ -0,0 +1,7 @@
+nav:
+- 'Home': index.md
+- getting-started
+- catalyst-standards
+- architecture
+- 'Library': libs
+- appendix
diff --git a/docs/src/appendix/important/.pages b/docs/src/appendix/important/.pages
@@ -0,0 +1,6 @@
+nav:
+  - index.md
+  - contributing.md
+  - coc.md
+  - security.md
+  - license.md
diff --git a/docs/src/appendix/important/coc.md b/docs/src/appendix/important/coc.md
@@ -0,0 +1,8 @@
+---
+icon: material/file-sign
+title: Code of Conduct
+---
+
+<!-- markdownlint-disable first-line-h1 -->
+<!-- markdownlint-disable required-headings -->
+{{ include_file('includes/repo/CODE_OF_CONDUCT.md') }}
diff --git a/docs/src/appendix/important/contributing.md b/docs/src/appendix/important/contributing.md
@@ -0,0 +1,7 @@
+---
+icon: material/pen-plus
+---
+
+<!-- markdownlint-disable first-line-h1 -->
+<!-- markdownlint-disable required-headings -->
+{{ include_file('includes/repo/CONTRIBUTING.md') }}
diff --git a/docs/src/appendix/important/index.md b/docs/src/appendix/important/index.md
@@ -0,0 +1,5 @@
+---
+icon: material/alert-decagram-outline
+---
+
+# Important
diff --git a/docs/src/appendix/important/license.md b/docs/src/appendix/important/license.md
@@ -0,0 +1,19 @@
+---
+icon: material/license
+---
+
+# License
+
+<!-- markdownlint-disable max-one-sentence-per-line -->
+
+??? note "Apache 2 License"
+
+    ```text
+    {{ include_file('includes/repo/LICENSE-APACHE', 0, -1, 8) }}
+    ```
+
+??? note "MIT License"
+
+    ```text
+    {{ include_file('includes/repo/LICENSE-MIT', 0, -1, 8) }}
+    ```
diff --git a/docs/src/appendix/important/security.md b/docs/src/appendix/important/security.md
@@ -0,0 +1,7 @@
+---
+icon: material/security
+---
+
+<!-- markdownlint-disable first-line-h1 -->
+<!-- markdownlint-disable required-headings -->
+{{ include_file('includes/repo/SECURITY.md') }}
diff --git a/docs/src/appendix/index.md b/docs/src/appendix/index.md
@@ -0,0 +1,7 @@
+---
+icon: material/file-document-plus-outline
+---
+
+# Appendix
+
+The appendix contains collections of extra information and examples relevant to Catalyst Library.
diff --git a/docs/src/appendix/tags.md b/docs/src/appendix/tags.md
@@ -0,0 +1,7 @@
+---
+icon: fontawesome/solid/tags
+---
+
+# Tag Index
+
+[TAGS]
diff --git a/docs/src/architecture/.pages b/docs/src/architecture/.pages
@@ -0,0 +1,14 @@
+nav:
+  - index.md
+  - 01_introduction_and_goals.md
+  - 02_architecture_constraints.md
+  - 03_system_scope_and_context.md
+  - 04_solution_strategy.md
+  - 05_building_block_view.md
+  - 06_runtime_view.md
+  - 07_deployment_view.md
+  - 08_concepts
+  - 09_architecture_decisions
+  - 10_quality
+  - 11_technical_risks.md
+  - 12_glossary.md
diff --git a/docs/src/architecture/01_introduction_and_goals.md b/docs/src/architecture/01_introduction_and_goals.md
@@ -0,0 +1,33 @@
+---
+icon: octicons/goal-24
+---
+
+# Introduction and Goals
+
+<!-- See: https://docs.arc42.org/section-1/ -->
+
+## Requirements Overview
+
+## Quality Goals
+
+Main quality goals:
+
+|  Quality Category |  Quality   |  Description |
+|:-:|:-:|:-:|
+| Usable |  User experience  | The libraries should offer an intuitive and easy-to-navigate interface |
+| Usable  | Correctness  |The functionality provided by the libraries should deliver accurate and expected results |
+| Secure   | Access control  | Role-Based Access Control  |
+| Secure   | Privacy  | User information are kept private  |
+| Secure   | Accountability  |  Actions and results generated by the libraries should be traceable and auditable by authorized parties |
+| Reliable   |  Fail-safe | In case of failures, the libraries should be designed to prevent data loss and ensure system stability |
+
+## Stakeholders
+
+| Role/Name   | Contact        |
+|-------------|----------------|
+| *Product-Owner* | *Mike* |
+| *Developers* | *Catalyst-Team* |
+| *Users* | *Catalyst-Community* |
+| *Admin* | *Danny* |
+| *SRE* | *Josh* |
+| *Testers* | *Catalyst-QA-Team* |
diff --git a/docs/src/architecture/02_architecture_constraints.md b/docs/src/architecture/02_architecture_constraints.md
@@ -0,0 +1,7 @@
+---
+icon: material/handcuffs
+---
+
+# Architecture Constraints
+
+<!-- See: https://docs.arc42.org/section-2/ -->
diff --git a/docs/src/architecture/03_system_scope_and_context.md b/docs/src/architecture/03_system_scope_and_context.md
@@ -0,0 +1,21 @@
+---
+icon: material/telescope
+---
+
+# System Scope and Context
+
+<!-- See: https://docs.arc42.org/section-3/ -->
+
+## Business Context
+
+... **~Diagram or Table~**
+
+... **~optionally: Explanation of external domain interfaces~**
+
+## Technical Context
+
+... **~Diagram or Table~**
+
+... **~optionally: Explanation of technical interfaces~**
+
+... **~Mapping Input/Output to Channels~**
diff --git a/docs/src/architecture/04_solution_strategy.md b/docs/src/architecture/04_solution_strategy.md
@@ -0,0 +1,7 @@
+---
+icon: material/strategy
+---
+
+# Solution Strategy
+
+<!-- See: https://docs.arc42.org/section-4/ -->
diff --git a/docs/src/architecture/05_building_block_view.md b/docs/src/architecture/05_building_block_view.md
@@ -0,0 +1,78 @@
+---
+icon: material/toy-brick-search
+---
+
+# Building Block View
+
+<!-- See: https://docs.arc42.org/section-5/ -->
+
+## White box Overall System
+
+... ***~Overview Diagram~***
+
+Motivation  
+... *~text explanation~*
+
+Contained Building Blocks  
+... *~Description of contained building block (black boxes)~*
+
+Important Interfaces  
+... *~Description of important interfaces~*
+
+### ~Name black box 1~
+
+... *~Purpose/Responsibility~*
+
+... *~Interface(s)~*
+
+... *~(Optional) Quality/Performance Characteristics~*
+
+... *~(Optional) Directory/File Location~*
+
+... *~(Optional) Fulfilled Requirements~*
+
+... *~(optional) Open Issues/Problems/Risks~*
+
+### ~Name black box 2~
+
+... *~black box template~*
+
+### ~Name black box n~
+
+... *~black box template~*
+
+### ~Name interface 1~
+
+…
+
+### ~Name interface m~
+
+## Level 2
+
+### White Box *~building block 1~*
+
+... *~white box template~*
+
+### White Box *~building block 2~*
+
+... *~white box template~*
+
+…
+
+### White Box *~building block m~*
+
+... *~white box template~*
+
+## Level 3
+
+### White Box ~\_building block x.1\_\~
+
+... *~white box template~*
+
+### White Box ~\_building block x.2\_\~
+
+... *~white box template~*
+
+### White Box ~\_building block y.1\_\~
+
+... *~white box template~*