Skip to content

Commit 6b92107

Browse files
msievenpipermsievenpiper
authored
baseline documentation (#61)
* - add some early stages documentation and diagrams * - update references from bin to cubex file * - remove local build files
1 parent 91423db commit 6b92107

File tree

14 files changed

+2165
-0
lines changed

14 files changed

+2165
-0
lines changed

‎docs/Gemfile‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
source "https://rubygems.org"
2+
3+
gem "jekyll", "~> 4.3"
4+
gem "just-the-docs"
5+
gem "webrick" # Required for Ruby 3+

‎docs/Gemfile.lock‎

Lines changed: 178 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,178 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
addressable (2.8.8)
5+
public_suffix (>= 2.0.2, < 8.0)
6+
base64 (0.3.0)
7+
bigdecimal (4.0.1)
8+
colorator (1.1.0)
9+
concurrent-ruby (1.3.6)
10+
csv (3.3.5)
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.3)
16+
ffi (1.17.3-arm-linux-gnu)
17+
ffi (1.17.3-arm-linux-musl)
18+
ffi (1.17.3-arm64-darwin)
19+
forwardable-extended (2.6.0)
20+
google-protobuf (4.33.5)
21+
bigdecimal
22+
rake (>= 13)
23+
http_parser.rb (0.8.1)
24+
i18n (1.14.8)
25+
concurrent-ruby (~> 1.0)
26+
jekyll (4.4.1)
27+
addressable (~> 2.4)
28+
base64 (~> 0.2)
29+
colorator (~> 1.0)
30+
csv (~> 3.0)
31+
em-websocket (~> 0.5)
32+
i18n (~> 1.0)
33+
jekyll-sass-converter (>= 2.0, < 4.0)
34+
jekyll-watch (~> 2.0)
35+
json (~> 2.6)
36+
kramdown (~> 2.3, >= 2.3.1)
37+
kramdown-parser-gfm (~> 1.0)
38+
liquid (~> 4.0)
39+
mercenary (~> 0.3, >= 0.3.6)
40+
pathutil (~> 0.9)
41+
rouge (>= 3.0, < 5.0)
42+
safe_yaml (~> 1.0)
43+
terminal-table (>= 1.8, < 4.0)
44+
webrick (~> 1.7)
45+
jekyll-include-cache (0.2.1)
46+
jekyll (>= 3.7, < 5.0)
47+
jekyll-sass-converter (3.1.0)
48+
sass-embedded (~> 1.75)
49+
jekyll-seo-tag (2.8.0)
50+
jekyll (>= 3.8, < 5.0)
51+
jekyll-watch (2.2.1)
52+
listen (~> 3.0)
53+
json (2.18.1)
54+
just-the-docs (0.12.0)
55+
jekyll (>= 3.8.5)
56+
jekyll-include-cache
57+
jekyll-seo-tag (>= 2.0)
58+
rake (>= 12.3.1)
59+
kramdown (2.5.2)
60+
rexml (>= 3.4.4)
61+
kramdown-parser-gfm (1.1.0)
62+
kramdown (~> 2.0)
63+
liquid (4.0.4)
64+
listen (3.10.0)
65+
logger
66+
rb-fsevent (~> 0.10, >= 0.10.3)
67+
rb-inotify (~> 0.9, >= 0.9.10)
68+
logger (1.7.0)
69+
mercenary (0.4.0)
70+
pathutil (0.16.2)
71+
forwardable-extended (~> 2.6)
72+
public_suffix (7.0.2)
73+
rake (13.3.1)
74+
rb-fsevent (0.11.2)
75+
rb-inotify (0.11.1)
76+
ffi (~> 1.0)
77+
rexml (3.4.4)
78+
rouge (4.7.0)
79+
safe_yaml (1.0.5)
80+
sass-embedded (1.97.3)
81+
google-protobuf (~> 4.31)
82+
rake (>= 13)
83+
sass-embedded (1.97.3-aarch64-linux-android)
84+
google-protobuf (~> 4.31)
85+
sass-embedded (1.97.3-arm-linux-androideabi)
86+
google-protobuf (~> 4.31)
87+
sass-embedded (1.97.3-arm-linux-gnueabihf)
88+
google-protobuf (~> 4.31)
89+
sass-embedded (1.97.3-arm-linux-musleabihf)
90+
google-protobuf (~> 4.31)
91+
sass-embedded (1.97.3-arm64-darwin)
92+
google-protobuf (~> 4.31)
93+
sass-embedded (1.97.3-riscv64-linux-android)
94+
google-protobuf (~> 4.31)
95+
sass-embedded (1.97.3-riscv64-linux-gnu)
96+
google-protobuf (~> 4.31)
97+
sass-embedded (1.97.3-riscv64-linux-musl)
98+
google-protobuf (~> 4.31)
99+
sass-embedded (1.97.3-x86_64-linux-android)
100+
google-protobuf (~> 4.31)
101+
terminal-table (3.0.2)
102+
unicode-display_width (>= 1.1.1, < 3)
103+
unicode-display_width (2.6.0)
104+
webrick (1.9.2)
105+
106+
PLATFORMS
107+
aarch64-linux-android
108+
arm-linux-androideabi
109+
arm-linux-gnu
110+
arm-linux-gnueabihf
111+
arm-linux-musl
112+
arm-linux-musleabihf
113+
arm64-darwin-24
114+
riscv64-linux-android
115+
riscv64-linux-gnu
116+
riscv64-linux-musl
117+
ruby
118+
x86_64-linux-android
119+
120+
DEPENDENCIES
121+
jekyll (~> 4.3)
122+
just-the-docs
123+
webrick
124+
125+
CHECKSUMS
126+
addressable (2.8.8) sha256=7c13b8f9536cf6364c03b9d417c19986019e28f7c00ac8132da4eb0fe393b057
127+
base64 (0.3.0) sha256=27337aeabad6ffae05c265c450490628ef3ebd4b67be58257393227588f5a97b
128+
bigdecimal (4.0.1) sha256=8b07d3d065a9f921c80ceaea7c9d4ae596697295b584c296fe599dd0ad01c4a7
129+
colorator (1.1.0) sha256=e2f85daf57af47d740db2a32191d1bdfb0f6503a0dfbc8327d0c9154d5ddfc38
130+
concurrent-ruby (1.3.6) sha256=6b56837e1e7e5292f9864f34b69c5a2cbc75c0cf5338f1ce9903d10fa762d5ab
131+
csv (3.3.5) sha256=6e5134ac3383ef728b7f02725d9872934f523cb40b961479f69cf3afa6c8e73f
132+
em-websocket (0.5.3) sha256=f56a92bde4e6cb879256d58ee31f124181f68f8887bd14d53d5d9a292758c6a8
133+
eventmachine (1.2.7) sha256=994016e42aa041477ba9cff45cbe50de2047f25dd418eba003e84f0d16560972
134+
ffi (1.17.3) sha256=0e9f39f7bb3934f77ad6feab49662be77e87eedcdeb2a3f5c0234c2938563d4c
135+
ffi (1.17.3-arm-linux-gnu) sha256=5bd4cea83b68b5ec0037f99c57d5ce2dd5aa438f35decc5ef68a7d085c785668
136+
ffi (1.17.3-arm-linux-musl) sha256=0d7626bb96265f9af78afa33e267d71cfef9d9a8eb8f5525344f8da6c7d76053
137+
ffi (1.17.3-arm64-darwin) sha256=0c690555d4cee17a7f07c04d59df39b2fba74ec440b19da1f685c6579bb0717f
138+
forwardable-extended (2.6.0) sha256=1bec948c469bbddfadeb3bd90eb8c85f6e627a412a3e852acfd7eaedbac3ec97
139+
google-protobuf (4.33.5) sha256=1b64fb774c101b23ac3f6923eca24be04fd971635d235c4cd4cfe0d752620da0
140+
http_parser.rb (0.8.1) sha256=9ae8df145b39aa5398b2f90090d651c67bd8e2ebfe4507c966579f641e11097a
141+
i18n (1.14.8) sha256=285778639134865c5e0f6269e0b818256017e8cde89993fdfcbfb64d088824a5
142+
jekyll (4.4.1) sha256=4c1144d857a5b2b80d45b8cf5138289579a9f8136aadfa6dd684b31fe2bc18c1
143+
jekyll-include-cache (0.2.1) sha256=c7d4b9e551732a27442cb2ce853ba36a2f69c66603694b8c1184c99ab1a1a205
144+
jekyll-sass-converter (3.1.0) sha256=83925d84f1d134410c11d0c6643b0093e82e3a3cf127e90757a85294a3862443
145+
jekyll-seo-tag (2.8.0) sha256=3f2ed1916d56f14ebfa38e24acde9b7c946df70cb183af2cb5f0598f21ae6818
146+
jekyll-watch (2.2.1) sha256=bc44ed43f5e0a552836245a54dbff3ea7421ecc2856707e8a1ee203a8387a7e1
147+
json (2.18.1) sha256=fe112755501b8d0466b5ada6cf50c8c3f41e897fa128ac5d263ec09eedc9f986
148+
just-the-docs (0.12.0) sha256=15f2839ac9082898d60f33b978aa6f8e46fc50ba8fac20ae7a7f0e1fb295523e
149+
kramdown (2.5.2) sha256=1ba542204c66b6f9111ff00dcc26075b95b220b07f2905d8261740c82f7f02fa
150+
kramdown-parser-gfm (1.1.0) sha256=fb39745516427d2988543bf01fc4cf0ab1149476382393e0e9c48592f6581729
151+
liquid (4.0.4) sha256=4fcfebb1a045e47918388dbb7a0925e7c3893e58d2bd6c3b3c73ec17a2d8fdb3
152+
listen (3.10.0) sha256=c6e182db62143aeccc2e1960033bebe7445309c7272061979bb098d03760c9d2
153+
logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203
154+
mercenary (0.4.0) sha256=b25a1e4a59adca88665e08e24acf0af30da5b5d859f7d8f38fba52c28f405138
155+
pathutil (0.16.2) sha256=e43b74365631cab4f6d5e4228f812927efc9cb2c71e62976edcb252ee948d589
156+
public_suffix (7.0.2) sha256=9114090c8e4e7135c1fd0e7acfea33afaab38101884320c65aaa0ffb8e26a857
157+
rake (13.3.1) sha256=8c9e89d09f66a26a01264e7e3480ec0607f0c497a861ef16063604b1b08eb19c
158+
rb-fsevent (0.11.2) sha256=43900b972e7301d6570f64b850a5aa67833ee7d87b458ee92805d56b7318aefe
159+
rb-inotify (0.11.1) sha256=a0a700441239b0ff18eb65e3866236cd78613d6b9f78fea1f9ac47a85e47be6e
160+
rexml (3.4.4) sha256=19e0a2c3425dfbf2d4fc1189747bdb2f849b6c5e74180401b15734bc97b5d142
161+
rouge (4.7.0) sha256=dba5896715c0325c362e895460a6d350803dbf6427454f49a47500f3193ea739
162+
safe_yaml (1.0.5) sha256=a6ac2d64b7eb027bdeeca1851fe7e7af0d668e133e8a88066a0c6f7087d9f848
163+
sass-embedded (1.97.3) sha256=c4136da69ae3acfa7b0809f4ec10891125edf57df214a2d1ab570f721f96f7a6
164+
sass-embedded (1.97.3-aarch64-linux-android) sha256=623b2f52fed6e3696c6445406e4efaef57b54442cc35604bfffbb82aef7d5c45
165+
sass-embedded (1.97.3-arm-linux-androideabi) sha256=e2ef33b187066e09374023e58e72cf3b5baabe6b77ecd74356fe9b4892a1c6e1
166+
sass-embedded (1.97.3-arm-linux-gnueabihf) sha256=ce443b57f3d7f03740267cf0f2cdff13e8055dd5938488967746f29f230222da
167+
sass-embedded (1.97.3-arm-linux-musleabihf) sha256=be3972424616f916ce1f4f41228266d57339e490dfd7ca0cea5588579564d4c0
168+
sass-embedded (1.97.3-arm64-darwin) sha256=8897d3503efe75c30584070a7104095545f5157665029aeb9bff3fa533a73861
169+
sass-embedded (1.97.3-riscv64-linux-android) sha256=201426b3e58611aa8cf34a7574df51905ec42fefb5a69982cc8497ac7fb26a6b
170+
sass-embedded (1.97.3-riscv64-linux-gnu) sha256=d7bac32f4de55c589a036da13ac4482bf5b7dfac980b4c0203d31a1bd9f07622
171+
sass-embedded (1.97.3-riscv64-linux-musl) sha256=621d981d700e2b8d0459b5ea696fff746dfa07d6b6bbc70cd982905214b07888
172+
sass-embedded (1.97.3-x86_64-linux-android) sha256=8f5e179bee8610be432499f228ea4e53ab362b1db0da1ae3cd3e76b114712372
173+
terminal-table (3.0.2) sha256=f951b6af5f3e00203fb290a669e0a85c5dd5b051b3b023392ccfd67ba5abae91
174+
unicode-display_width (2.6.0) sha256=12279874bba6d5e4d2728cef814b19197dbb10d7a7837a869bab65da943b7f5a
175+
webrick (1.9.2) sha256=beb4a15fc474defed24a3bda4ffd88a490d517c9e4e6118c3edce59e45864131
176+
177+
BUNDLED WITH
178+
4.0.3

‎docs/_config.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
title: Cubex Framework
2+
description: Documentation for the Cubex PHP 8.2+ web application framework
3+
theme: just-the-docs
4+
5+
url: https://cubex.github.io
6+
baseurl: /framework
7+
8+
aux_links:
9+
"GitHub":
10+
- "https://github.com/cubex/framework"
11+
"Packagist":
12+
- "https://packagist.org/packages/cubex/framework"
13+
14+
nav_sort: order
15+
16+
mermaid:
17+
version: "11.4.1"
18+
19+
callouts:
20+
note:
21+
title: Note
22+
color: blue
23+
warning:
24+
title: Warning
25+
color: red
26+
tip:
27+
title: Tip
28+
color: green

‎docs/_includes/head_custom.html‎

Whitespace-only changes.

0 commit comments

Comments
 (0)