Skip to content

Commit d064bd0

Browse files
sarkensarken
authored
Overhaul and relocate front end docs
2 parents 4da0a44 + 0cf90bd commit d064bd0

Some content is hidden

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

42 files changed

+4551
-3
lines changed

‎.github/dependabot.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: bundler
4+
directory: /
5+
schedule:
6+
interval: daily
7+
allow:
8+
- dependency-type: direct
9+
- package-ecosystem: "github-actions"
10+
directory: "/"
11+
schedule:
12+
interval: daily
13+
time: "10:00"
14+
open-pull-requests-limit: 10

‎.github/workflows/ci.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: ["master"]
6+
pull_request:
7+
8+
jobs:
9+
# Build job
10+
build:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v4
15+
- name: Setup Ruby
16+
uses: ruby/setup-ruby@v1
17+
with:
18+
ruby-version: '3.3' # Not needed with a .ruby-version file
19+
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
20+
cache-version: 0 # Increment this number if you need to re-download cached gems
21+
- name: Build with Jekyll
22+
run: bundle exec jekyll build

‎.github/workflows/pages.yml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# This workflow uses actions that are not certified by GitHub.
2+
# They are provided by a third-party and are governed by
3+
# separate terms of service, privacy policy, and support
4+
# documentation.
5+
6+
# Sample workflow for building and deploying a Jekyll site to GitHub Pages
7+
name: Deploy Jekyll site to Pages
8+
9+
on:
10+
push:
11+
branches: ["master"]
12+
13+
# Allows you to run this workflow manually from the Actions tab
14+
workflow_dispatch:
15+
16+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
17+
permissions:
18+
contents: read
19+
pages: write
20+
id-token: write
21+
22+
# Allow one concurrent deployment
23+
concurrency:
24+
group: "pages"
25+
cancel-in-progress: true
26+
27+
jobs:
28+
# Build job
29+
build:
30+
runs-on: ubuntu-latest
31+
steps:
32+
- name: Checkout
33+
uses: actions/checkout@v4
34+
- name: Setup Ruby
35+
uses: ruby/setup-ruby@v1
36+
with:
37+
ruby-version: '3.3' # Not needed with a .ruby-version file
38+
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
39+
cache-version: 0 # Increment this number if you need to re-download cached gems
40+
- name: Setup Pages
41+
id: pages
42+
uses: actions/configure-pages@v5
43+
- name: Build with Jekyll
44+
# Outputs to the './_site' directory by default
45+
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
46+
env:
47+
JEKYLL_ENV: production
48+
- name: Upload artifact
49+
# Automatically uploads an artifact from the './_site' directory by default
50+
uses: actions/upload-pages-artifact@v3
51+
52+
# Deployment job
53+
deploy:
54+
environment:
55+
name: github-pages
56+
url: ${{ steps.deployment.outputs.page_url }}
57+
runs-on: ubuntu-latest
58+
needs: build
59+
steps:
60+
- name: Deploy to GitHub Pages
61+
id: deployment
62+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Not sure what a .gitignore is?
2+
# See: https://git-scm.com/docs/gitignore
3+
4+
# These are directly copied from Jekyll's first-party docs on `.gitignore` files:
5+
# https://jekyllrb.com/tutorials/using-jekyll-with-bundler/#commit-to-source-control
6+
7+
# Ignore the default location of the built site, and caches and metadata generated by Jekyll
8+
_site/
9+
.sass-cache/
10+
.jekyll-cache/
11+
.jekyll-metadata
12+
13+
# Ignore folders generated by Bundler
14+
.bundle/
15+
vendor/

‎404.html‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
permalink: /404.html
3+
layout: page
4+
---
5+
6+
<style type="text/css" media="screen">
7+
.container {
8+
margin: 10px auto;
9+
max-width: 600px;
10+
text-align: center;
11+
}
12+
h1 {
13+
margin: 30px 0;
14+
font-size: 4em;
15+
line-height: 1;
16+
letter-spacing: -1px;
17+
}
18+
</style>
19+
20+
<div class="container">
21+
<h1>404</h1>
22+
23+
<p><strong>Page not found :(</strong></p>
24+
<p>The requested page could not be found.</p>
25+
</div>

‎Gemfile‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
source 'https://rubygems.org'
2+
3+
gem "jekyll", "~> 4.4.1" # installed by `gem jekyll`
4+
# gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2
5+
6+
gem "just-the-docs", "0.10.1" # pinned to the current release
7+
# gem "just-the-docs" # always download the latest release
8+
9+
gem "jekyll-redirect-from"

‎Gemfile.lock‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
addressable (2.8.7)
5+
public_suffix (>= 2.0.2, < 7.0)
6+
base64 (0.2.0)
7+
bigdecimal (3.1.9)
8+
colorator (1.1.0)
9+
concurrent-ruby (1.3.5)
10+
csv (3.3.2)
11+
em-websocket (0.5.3)
12+
eventmachine (>= 0.12.9)
13+
http_parser.rb (~> 0)
14+
eventmachine (1.2.7)
15+
ffi (1.17.1-arm64-darwin)
16+
ffi (1.17.1-x86_64-linux-gnu)
17+
forwardable-extended (2.6.0)
18+
google-protobuf (4.29.3-arm64-darwin)
19+
bigdecimal
20+
rake (>= 13)
21+
google-protobuf (4.29.3-x86_64-linux)
22+
bigdecimal
23+
rake (>= 13)
24+
http_parser.rb (0.8.0)
25+
i18n (1.14.7)
26+
concurrent-ruby (~> 1.0)
27+
jekyll (4.4.1)
28+
addressable (~> 2.4)
29+
base64 (~> 0.2)
30+
colorator (~> 1.0)
31+
csv (~> 3.0)
32+
em-websocket (~> 0.5)
33+
i18n (~> 1.0)
34+
jekyll-sass-converter (>= 2.0, < 4.0)
35+
jekyll-watch (~> 2.0)
36+
json (~> 2.6)
37+
kramdown (~> 2.3, >= 2.3.1)
38+
kramdown-parser-gfm (~> 1.0)
39+
liquid (~> 4.0)
40+
mercenary (~> 0.3, >= 0.3.6)
41+
pathutil (~> 0.9)
42+
rouge (>= 3.0, < 5.0)
43+
safe_yaml (~> 1.0)
44+
terminal-table (>= 1.8, < 4.0)
45+
webrick (~> 1.7)
46+
jekyll-include-cache (0.2.1)
47+
jekyll (>= 3.7, < 5.0)
48+
jekyll-redirect-from (0.16.0)
49+
jekyll (>= 3.3, < 5.0)
50+
jekyll-sass-converter (3.0.0)
51+
sass-embedded (~> 1.54)
52+
jekyll-seo-tag (2.8.0)
53+
jekyll (>= 3.8, < 5.0)
54+
jekyll-watch (2.2.1)
55+
listen (~> 3.0)
56+
json (2.9.1)
57+
just-the-docs (0.10.1)
58+
jekyll (>= 3.8.5)
59+
jekyll-include-cache
60+
jekyll-seo-tag (>= 2.0)
61+
rake (>= 12.3.1)
62+
kramdown (2.5.1)
63+
rexml (>= 3.3.9)
64+
kramdown-parser-gfm (1.1.0)
65+
kramdown (~> 2.0)
66+
liquid (4.0.4)
67+
listen (3.9.0)
68+
rb-fsevent (~> 0.10, >= 0.10.3)
69+
rb-inotify (~> 0.9, >= 0.9.10)
70+
mercenary (0.4.0)
71+
pathutil (0.16.2)
72+
forwardable-extended (~> 2.6)
73+
public_suffix (6.0.1)
74+
rake (13.2.1)
75+
rb-fsevent (0.11.2)
76+
rb-inotify (0.11.1)
77+
ffi (~> 1.0)
78+
rexml (3.4.0)
79+
rouge (4.5.1)
80+
safe_yaml (1.0.5)
81+
sass-embedded (1.83.4-arm64-darwin)
82+
google-protobuf (~> 4.29)
83+
sass-embedded (1.83.4-x86_64-linux-gnu)
84+
google-protobuf (~> 4.29)
85+
terminal-table (3.0.2)
86+
unicode-display_width (>= 1.1.1, < 3)
87+
unicode-display_width (2.6.0)
88+
webrick (1.9.1)
89+
90+
PLATFORMS
91+
arm64-darwin
92+
x86_64-linux-gnu
93+
94+
DEPENDENCIES
95+
jekyll (~> 4.4.1)
96+
jekyll-redirect-from
97+
just-the-docs (= 0.10.1)
98+
99+
BUNDLED WITH
100+
2.5.9

0 commit comments

Comments
 (0)