Skip to content

Commit 0de3232

Browse files
bkioshnbkioshn
authored
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
1 parent 920595c commit 0de3232

File tree

96 files changed

+13547
-2
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

96 files changed

+13547
-2
lines changed

‎.config/dictionaries/project.dic

+12
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ DBSTATUS
5050
dbsync
5151
dcbor
5252
delegators
53+
Dominik
5354
dockerhub
5455
dotenv
5556
dotenvy
@@ -59,6 +60,7 @@ dreps
5960
earthfile
6061
Earthfile
6162
encryptor
63+
Eternl
6264
Errno
6365
excalidraw
6466
fadvise
@@ -117,6 +119,8 @@ localizable
117119
lookaside
118120
maindbname
119121
mapref
122+
Metadatum
123+
metadatum
120124
mdlint
121125
mdns
122126
minicbor
@@ -138,6 +142,7 @@ nolfs
138142
notadb
139143
nsec
140144
OCSP
145+
Oleksandr
141146
oneshot
142147
openapi
143148
openat
@@ -157,6 +162,7 @@ preopen
157162
preopened
158163
preopens
159164
preprod
165+
Prokhorenko
160166
psql
161167
pubk
162168
pubkey
@@ -170,6 +176,7 @@ readlinkat
170176
redoc
171177
REMOVEDIR
172178
renameat
179+
Replayability
173180
reqwest
174181
retriggering
175182
rlib
@@ -205,6 +212,7 @@ testcase
205212
testcov
206213
testdocs
207214
testunit
215+
testplan
208216
thiserror
209217
timelike
210218
timespec
@@ -220,8 +228,12 @@ unixfs
220228
unlinkat
221229
upnp
222230
userid
231+
UTXO
223232
utimensat
224233
vitss
234+
Vkey
235+
vkey
236+
vkeywitness
225237
voteplan
226238
voteplans
227239
wasi

‎docs/.gitkeep

Whitespace-only changes.

‎docs/Earthfile

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
VERSION 0.8
2+
3+
IMPORT github.com/input-output-hk/catalyst-ci/earthly/docs:v3.1.21 AS docs-ci
4+
5+
IMPORT .. AS repo
6+
7+
# Copy all the source we need to build the docs
8+
src:
9+
# Common src setup
10+
DO docs-ci+SRC
11+
12+
# Now copy into that any artifacts we pull from the builds.
13+
COPY --dir repo+repo-docs/repo /docs/includes
14+
15+
16+
# Build the docs here.
17+
docs:
18+
FROM +src
19+
20+
DO docs-ci+BUILD
21+
22+
# local : Create a local image of the document.
23+
local:
24+
DO docs-ci+PACKAGE
25+
26+
# Copy the static pages into the container
27+
COPY +docs/ /usr/share/nginx/html
28+
29+
# This is a local only image, we do not publish it.
30+
SAVE IMAGE catalyst-libs-docs:latest

‎docs/mkdocs.yml

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
INHERIT: std-theme.yml
2+
3+
# Project Information
4+
site_name: Project Catalyst - Catalyst Library
5+
site_url: https://input-output-hk.github.io/catalyst-docs
6+
7+
# Repository
8+
repo_name: input-output-hk/catalyst-libs
9+
repo_url: https://github.com/input-output-hk/catalyst-libs
10+
11+
# Page tree - is created automatically.
12+
# See: https://henrywhitaker3.github.io/mkdocs-material-dark-theme/plugins/awesome-pages/
13+
14+
# Tags used in these docs
15+
extra:
16+
tags:
17+
HTML5: html
18+
JavaScript: js
19+
CSS: css
20+
Rust: rust
21+
Flutter: flutter
22+
Dart: dart
23+
Python: python
24+
Earthly: earthly
25+
Github: github
26+
Docker: docker
27+
arc42: arc42
28+
ADR: adr
29+
30+
# Icons associated with the tags
31+
theme:
32+
icon:
33+
tag:
34+
html: fontawesome/brands/html5
35+
js: fontawesome/brands/js
36+
css: fontawesome/brands/css3
37+
rust: simple/rust
38+
flutter: simple/flutter
39+
dart: simple/dart
40+
python: simple/python
41+
earthly: material/earth-plus
42+
github: simple/github
43+
docker: simple/docker
44+
arc42: material/pencil-ruler
45+
adr: material/arrow-decision-auto

‎docs/src/.pages

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
nav:
2+
- 'Home': index.md
3+
- getting-started
4+
- catalyst-standards
5+
- architecture
6+
- 'Library': libs
7+
- appendix

‎docs/src/appendix/important/.pages

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
nav:
2+
- index.md
3+
- contributing.md
4+
- coc.md
5+
- security.md
6+
- license.md

‎docs/src/appendix/important/coc.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
icon: material/file-sign
3+
title: Code of Conduct
4+
---
5+
6+
<!-- markdownlint-disable first-line-h1 -->
7+
<!-- markdownlint-disable required-headings -->
8+
{{ include_file('includes/repo/CODE_OF_CONDUCT.md') }}

‎docs/src/appendix/important/contributing.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
icon: material/pen-plus
3+
---
4+
5+
<!-- markdownlint-disable first-line-h1 -->
6+
<!-- markdownlint-disable required-headings -->
7+
{{ include_file('includes/repo/CONTRIBUTING.md') }}

‎docs/src/appendix/important/index.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
icon: material/alert-decagram-outline
3+
---
4+
5+
# Important

‎docs/src/appendix/important/license.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
icon: material/license
3+
---
4+
5+
# License
6+
7+
<!-- markdownlint-disable max-one-sentence-per-line -->
8+
9+
??? note "Apache 2 License"
10+
11+
```text
12+
{{ include_file('includes/repo/LICENSE-APACHE', 0, -1, 8) }}
13+
```
14+
15+
??? note "MIT License"
16+
17+
```text
18+
{{ include_file('includes/repo/LICENSE-MIT', 0, -1, 8) }}
19+
```

‎docs/src/appendix/important/security.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
icon: material/security
3+
---
4+
5+
<!-- markdownlint-disable first-line-h1 -->
6+
<!-- markdownlint-disable required-headings -->
7+
{{ include_file('includes/repo/SECURITY.md') }}

‎docs/src/appendix/index.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
icon: material/file-document-plus-outline
3+
---
4+
5+
# Appendix
6+
7+
The appendix contains collections of extra information and examples relevant to Catalyst Library.

‎docs/src/appendix/tags.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
icon: fontawesome/solid/tags
3+
---
4+
5+
# Tag Index
6+
7+
[TAGS]

‎docs/src/architecture/.pages

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
nav:
2+
- index.md
3+
- 01_introduction_and_goals.md
4+
- 02_architecture_constraints.md
5+
- 03_system_scope_and_context.md
6+
- 04_solution_strategy.md
7+
- 05_building_block_view.md
8+
- 06_runtime_view.md
9+
- 07_deployment_view.md
10+
- 08_concepts
11+
- 09_architecture_decisions
12+
- 10_quality
13+
- 11_technical_risks.md
14+
- 12_glossary.md

‎docs/src/architecture/01_introduction_and_goals.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
icon: octicons/goal-24
3+
---
4+
5+
# Introduction and Goals
6+
7+
<!-- See: https://docs.arc42.org/section-1/ -->
8+
9+
## Requirements Overview
10+
11+
## Quality Goals
12+
13+
Main quality goals:
14+
15+
| Quality Category | Quality | Description |
16+
|:-:|:-:|:-:|
17+
| Usable | User experience | The libraries should offer an intuitive and easy-to-navigate interface |
18+
| Usable | Correctness |The functionality provided by the libraries should deliver accurate and expected results |
19+
| Secure | Access control | Role-Based Access Control |
20+
| Secure | Privacy | User information are kept private |
21+
| Secure | Accountability | Actions and results generated by the libraries should be traceable and auditable by authorized parties |
22+
| Reliable | Fail-safe | In case of failures, the libraries should be designed to prevent data loss and ensure system stability |
23+
24+
## Stakeholders
25+
26+
| Role/Name | Contact |
27+
|-------------|----------------|
28+
| *Product-Owner* | *Mike* |
29+
| *Developers* | *Catalyst-Team* |
30+
| *Users* | *Catalyst-Community* |
31+
| *Admin* | *Danny* |
32+
| *SRE* | *Josh* |
33+
| *Testers* | *Catalyst-QA-Team* |

‎docs/src/architecture/02_architecture_constraints.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
icon: material/handcuffs
3+
---
4+
5+
# Architecture Constraints
6+
7+
<!-- See: https://docs.arc42.org/section-2/ -->

‎docs/src/architecture/03_system_scope_and_context.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
icon: material/telescope
3+
---
4+
5+
# System Scope and Context
6+
7+
<!-- See: https://docs.arc42.org/section-3/ -->
8+
9+
## Business Context
10+
11+
... **~Diagram or Table~**
12+
13+
... **~optionally: Explanation of external domain interfaces~**
14+
15+
## Technical Context
16+
17+
... **~Diagram or Table~**
18+
19+
... **~optionally: Explanation of technical interfaces~**
20+
21+
... **~Mapping Input/Output to Channels~**

‎docs/src/architecture/04_solution_strategy.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
icon: material/strategy
3+
---
4+
5+
# Solution Strategy
6+
7+
<!-- See: https://docs.arc42.org/section-4/ -->

‎docs/src/architecture/05_building_block_view.md

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
icon: material/toy-brick-search
3+
---
4+
5+
# Building Block View
6+
7+
<!-- See: https://docs.arc42.org/section-5/ -->
8+
9+
## White box Overall System
10+
11+
... ***~Overview Diagram~***
12+
13+
Motivation
14+
... *~text explanation~*
15+
16+
Contained Building Blocks
17+
... *~Description of contained building block (black boxes)~*
18+
19+
Important Interfaces
20+
... *~Description of important interfaces~*
21+
22+
### ~Name black box 1~
23+
24+
... *~Purpose/Responsibility~*
25+
26+
... *~Interface(s)~*
27+
28+
... *~(Optional) Quality/Performance Characteristics~*
29+
30+
... *~(Optional) Directory/File Location~*
31+
32+
... *~(Optional) Fulfilled Requirements~*
33+
34+
... *~(optional) Open Issues/Problems/Risks~*
35+
36+
### ~Name black box 2~
37+
38+
... *~black box template~*
39+
40+
### ~Name black box n~
41+
42+
... *~black box template~*
43+
44+
### ~Name interface 1~
45+
46+
…
47+
48+
### ~Name interface m~
49+
50+
## Level 2
51+
52+
### White Box *~building block 1~*
53+
54+
... *~white box template~*
55+
56+
### White Box *~building block 2~*
57+
58+
... *~white box template~*
59+
60+
…
61+
62+
### White Box *~building block m~*
63+
64+
... *~white box template~*
65+
66+
## Level 3
67+
68+
### White Box ~\_building block x.1\_\~
69+
70+
... *~white box template~*
71+
72+
### White Box ~\_building block x.2\_\~
73+
74+
... *~white box template~*
75+
76+
### White Box ~\_building block y.1\_\~
77+
78+
... *~white box template~*

0 commit comments

Comments
 (0)