Add just-the-docs based user-facing documentation

This commit is contained in:
Luke Parker
2024-03-11 17:55:27 -04:00
parent a3a009a7e9
commit c32d3413ba
20 changed files with 270 additions and 1 deletions

7
docs/.gitignore vendored Normal file
View File

@@ -0,0 +1,7 @@
_site/
.sass-cache/
.jekyll-cache/
.jekyll-metadata
.bundle/
vendor/

1
docs/.ruby-version Normal file
View File

@@ -0,0 +1 @@
3.1

5
docs/2_amm.md Normal file
View File

@@ -0,0 +1,5 @@
---
title: Automatic Market Makers
layout: default
nav_order: 2
---

5
docs/3_cross_chain.md Normal file
View File

@@ -0,0 +1,5 @@
---
title: Cross-Chain Architecture
layout: default
nav_order: 3
---

6
docs/4_0_economics.md Normal file
View File

@@ -0,0 +1,6 @@
---
title: Economics
layout: default
nav_order: 4
has_children: true
---

6
docs/4_1_genesis.md Normal file
View File

@@ -0,0 +1,6 @@
---
title: Genesis
layout: default
nav_order: 1
parent: Economics
---

6
docs/4_2_pre.md Normal file
View File

@@ -0,0 +1,6 @@
---
title: Pre-Economic Security
layout: default
nav_order: 2
parent: Economics
---

6
docs/4_3_post.md Normal file
View File

@@ -0,0 +1,6 @@
---
title: Post-Economic Security
layout: default
nav_order: 3
parent: Economics
---

View File

@@ -0,0 +1,6 @@
---
title: Infrastructure
layout: default
nav_order: 5
has_children: true
---

View File

@@ -0,0 +1,6 @@
---
title: Message Queue
layout: default
nav_order: 1
parent: Infrastructure
---

6
docs/5_2_processor.md Normal file
View File

@@ -0,0 +1,6 @@
---
title: Processor
layout: default
nav_order: 2
parent: Infrastructure
---

6
docs/5_3_coordinator.md Normal file
View File

@@ -0,0 +1,6 @@
---
title: Coordinator
layout: default
nav_order: 3
parent: Infrastructure
---

6
docs/5_4_serai.md Normal file
View File

@@ -0,0 +1,6 @@
---
title: Serai
layout: default
nav_order: 4
parent: Infrastructure
---

6
docs/6_0_validator.md Normal file
View File

@@ -0,0 +1,6 @@
---
title: Running a Validator
layout: default
nav_order: 6
has_children: true
---

4
docs/Gemfile Normal file
View File

@@ -0,0 +1,4 @@
source 'https://rubygems.org'
gem "jekyll", "~> 4.3.3"
gem "just-the-docs", "0.8.1"

82
docs/Gemfile.lock Normal file
View File

@@ -0,0 +1,82 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.8.6)
public_suffix (>= 2.0.2, < 6.0)
colorator (1.1.0)
concurrent-ruby (1.2.3)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
eventmachine (1.2.7)
ffi (1.16.3)
forwardable-extended (2.6.0)
google-protobuf (3.25.3-x86_64-linux)
http_parser.rb (0.8.0)
i18n (1.14.4)
concurrent-ruby (~> 1.0)
jekyll (4.3.3)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 1.0)
jekyll-sass-converter (>= 2.0, < 4.0)
jekyll-watch (~> 2.0)
kramdown (~> 2.3, >= 2.3.1)
kramdown-parser-gfm (~> 1.0)
liquid (~> 4.0)
mercenary (>= 0.3.6, < 0.5)
pathutil (~> 0.9)
rouge (>= 3.0, < 5.0)
safe_yaml (~> 1.0)
terminal-table (>= 1.8, < 4.0)
webrick (~> 1.7)
jekyll-include-cache (0.2.1)
jekyll (>= 3.7, < 5.0)
jekyll-sass-converter (3.0.0)
sass-embedded (~> 1.54)
jekyll-seo-tag (2.8.0)
jekyll (>= 3.8, < 5.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
just-the-docs (0.8.1)
jekyll (>= 3.8.5)
jekyll-include-cache
jekyll-seo-tag (>= 2.0)
rake (>= 12.3.1)
kramdown (2.4.0)
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.4)
listen (3.9.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (5.0.4)
rake (13.1.0)
rb-fsevent (0.11.2)
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.2.6)
rouge (4.2.0)
safe_yaml (1.0.5)
sass-embedded (1.63.6)
google-protobuf (~> 3.23)
rake (>= 13.0.0)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
unicode-display_width (2.5.0)
webrick (1.8.1)
PLATFORMS
x86_64-linux
DEPENDENCIES
jekyll (~> 4.3.3)
just-the-docs (= 0.8.1)
BUNDLED WITH
2.2.5

5
docs/_config.yml Normal file
View File

@@ -0,0 +1,5 @@
title: Serai Documentation
description: Documentation for the Serai protocol.
theme: just-the-docs
url: https://serai-dex.github.io/serai

7
docs/index.md Normal file
View File

@@ -0,0 +1,7 @@
---
title: Home
layout: home
nav_order: 1
---
Documentation for Serai.