Skip to content

Commit 2a14140

Browse files
mrubensmrubens
authored
Merge pull request RooCodeInc#680 from shanemmattner/add_docs
Add docs initial setup
2 parents 047ddf7 + 49375cf commit 2a14140

File tree

6 files changed

+397
-0
lines changed

6 files changed

+397
-0
lines changed

‎.github/workflows/pages.yml‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Deploy Jekyll site to Pages
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: false
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v3
23+
- name: Setup Ruby
24+
uses: ruby/setup-ruby@v1
25+
with:
26+
ruby-version: '3.1'
27+
bundler-cache: true
28+
- name: Setup Pages
29+
id: pages
30+
uses: actions/configure-pages@v3
31+
- name: Build with Jekyll
32+
run: |
33+
cd docs
34+
bundle init
35+
echo 'source "https://rubygems.org"' >> Gemfile
36+
echo 'gem "github-pages", group: :jekyll_plugins' >> Gemfile
37+
bundle install
38+
bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
39+
env:
40+
JEKYLL_ENV: production
41+
- name: Upload artifact
42+
uses: actions/upload-pages-artifact@v1
43+
44+
deploy:
45+
environment:
46+
name: github-pages
47+
url: ${{ steps.deployment.outputs.page_url }}
48+
runs-on: ubuntu-latest
49+
needs: build
50+
steps:
51+
- name: Deploy to GitHub Pages
52+
id: deployment
53+
uses: actions/deploy-pages@v2

‎docs/Gemfile‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
source 'https://rubygems.org'
2+
gem 'github-pages', group: :jekyll_plugins

‎docs/Gemfile.lock‎

Lines changed: 308 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,308 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
activesupport (8.0.1)
5+
base64
6+
benchmark (>= 0.3)
7+
bigdecimal
8+
concurrent-ruby (~> 1.0, >= 1.3.1)
9+
connection_pool (>= 2.2.5)
10+
drb
11+
i18n (>= 1.6, < 2)
12+
logger (>= 1.4.2)
13+
minitest (>= 5.1)
14+
securerandom (>= 0.3)
15+
tzinfo (~> 2.0, >= 2.0.5)
16+
uri (>= 0.13.1)
17+
addressable (2.8.7)
18+
public_suffix (>= 2.0.2, < 7.0)
19+
base64 (0.2.0)
20+
benchmark (0.4.0)
21+
bigdecimal (3.1.9)
22+
coffee-script (2.4.1)
23+
coffee-script-source
24+
execjs
25+
coffee-script-source (1.12.2)
26+
colorator (1.1.0)
27+
commonmarker (0.23.11)
28+
concurrent-ruby (1.3.5)
29+
connection_pool (2.5.0)
30+
csv (3.3.2)
31+
dnsruby (1.72.3)
32+
base64 (~> 0.2.0)
33+
simpleidn (~> 0.2.1)
34+
drb (2.2.1)
35+
em-websocket (0.5.3)
36+
eventmachine (>= 0.12.9)
37+
http_parser.rb (~> 0)
38+
ethon (0.16.0)
39+
ffi (>= 1.15.0)
40+
eventmachine (1.2.7)
41+
execjs (2.10.0)
42+
faraday (2.12.2)
43+
faraday-net_http (>= 2.0, < 3.5)
44+
json
45+
logger
46+
faraday-net_http (3.4.0)
47+
net-http (>= 0.5.0)
48+
ffi (1.17.1-aarch64-linux-gnu)
49+
ffi (1.17.1-aarch64-linux-musl)
50+
ffi (1.17.1-arm-linux-gnu)
51+
ffi (1.17.1-arm-linux-musl)
52+
ffi (1.17.1-arm64-darwin)
53+
ffi (1.17.1-x86_64-darwin)
54+
ffi (1.17.1-x86_64-linux-gnu)
55+
ffi (1.17.1-x86_64-linux-musl)
56+
forwardable-extended (2.6.0)
57+
gemoji (4.1.0)
58+
github-pages (232)
59+
github-pages-health-check (= 1.18.2)
60+
jekyll (= 3.10.0)
61+
jekyll-avatar (= 0.8.0)
62+
jekyll-coffeescript (= 1.2.2)
63+
jekyll-commonmark-ghpages (= 0.5.1)
64+
jekyll-default-layout (= 0.1.5)
65+
jekyll-feed (= 0.17.0)
66+
jekyll-gist (= 1.5.0)
67+
jekyll-github-metadata (= 2.16.1)
68+
jekyll-include-cache (= 0.2.1)
69+
jekyll-mentions (= 1.6.0)
70+
jekyll-optional-front-matter (= 0.3.2)
71+
jekyll-paginate (= 1.1.0)
72+
jekyll-readme-index (= 0.3.0)
73+
jekyll-redirect-from (= 0.16.0)
74+
jekyll-relative-links (= 0.6.1)
75+
jekyll-remote-theme (= 0.4.3)
76+
jekyll-sass-converter (= 1.5.2)
77+
jekyll-seo-tag (= 2.8.0)
78+
jekyll-sitemap (= 1.4.0)
79+
jekyll-swiss (= 1.0.0)
80+
jekyll-theme-architect (= 0.2.0)
81+
jekyll-theme-cayman (= 0.2.0)
82+
jekyll-theme-dinky (= 0.2.0)
83+
jekyll-theme-hacker (= 0.2.0)
84+
jekyll-theme-leap-day (= 0.2.0)
85+
jekyll-theme-merlot (= 0.2.0)
86+
jekyll-theme-midnight (= 0.2.0)
87+
jekyll-theme-minimal (= 0.2.0)
88+
jekyll-theme-modernist (= 0.2.0)
89+
jekyll-theme-primer (= 0.6.0)
90+
jekyll-theme-slate (= 0.2.0)
91+
jekyll-theme-tactile (= 0.2.0)
92+
jekyll-theme-time-machine (= 0.2.0)
93+
jekyll-titles-from-headings (= 0.5.3)
94+
jemoji (= 0.13.0)
95+
kramdown (= 2.4.0)
96+
kramdown-parser-gfm (= 1.1.0)
97+
liquid (= 4.0.4)
98+
mercenary (~> 0.3)
99+
minima (= 2.5.1)
100+
nokogiri (>= 1.16.2, < 2.0)
101+
rouge (= 3.30.0)
102+
terminal-table (~> 1.4)
103+
webrick (~> 1.8)
104+
github-pages-health-check (1.18.2)
105+
addressable (~> 2.3)
106+
dnsruby (~> 1.60)
107+
octokit (>= 4, < 8)
108+
public_suffix (>= 3.0, < 6.0)
109+
typhoeus (~> 1.3)
110+
html-pipeline (2.14.3)
111+
activesupport (>= 2)
112+
nokogiri (>= 1.4)
113+
http_parser.rb (0.8.0)
114+
i18n (1.14.7)
115+
concurrent-ruby (~> 1.0)
116+
jekyll (3.10.0)
117+
addressable (~> 2.4)
118+
colorator (~> 1.0)
119+
csv (~> 3.0)
120+
em-websocket (~> 0.5)
121+
i18n (>= 0.7, < 2)
122+
jekyll-sass-converter (~> 1.0)
123+
jekyll-watch (~> 2.0)
124+
kramdown (>= 1.17, < 3)
125+
liquid (~> 4.0)
126+
mercenary (~> 0.3.3)
127+
pathutil (~> 0.9)
128+
rouge (>= 1.7, < 4)
129+
safe_yaml (~> 1.0)
130+
webrick (>= 1.0)
131+
jekyll-avatar (0.8.0)
132+
jekyll (>= 3.0, < 5.0)
133+
jekyll-coffeescript (1.2.2)
134+
coffee-script (~> 2.2)
135+
coffee-script-source (~> 1.12)
136+
jekyll-commonmark (1.4.0)
137+
commonmarker (~> 0.22)
138+
jekyll-commonmark-ghpages (0.5.1)
139+
commonmarker (>= 0.23.7, < 1.1.0)
140+
jekyll (>= 3.9, < 4.0)
141+
jekyll-commonmark (~> 1.4.0)
142+
rouge (>= 2.0, < 5.0)
143+
jekyll-default-layout (0.1.5)
144+
jekyll (>= 3.0, < 5.0)
145+
jekyll-feed (0.17.0)
146+
jekyll (>= 3.7, < 5.0)
147+
jekyll-gist (1.5.0)
148+
octokit (~> 4.2)
149+
jekyll-github-metadata (2.16.1)
150+
jekyll (>= 3.4, < 5.0)
151+
octokit (>= 4, < 7, != 4.4.0)
152+
jekyll-include-cache (0.2.1)
153+
jekyll (>= 3.7, < 5.0)
154+
jekyll-mentions (1.6.0)
155+
html-pipeline (~> 2.3)
156+
jekyll (>= 3.7, < 5.0)
157+
jekyll-optional-front-matter (0.3.2)
158+
jekyll (>= 3.0, < 5.0)
159+
jekyll-paginate (1.1.0)
160+
jekyll-readme-index (0.3.0)
161+
jekyll (>= 3.0, < 5.0)
162+
jekyll-redirect-from (0.16.0)
163+
jekyll (>= 3.3, < 5.0)
164+
jekyll-relative-links (0.6.1)
165+
jekyll (>= 3.3, < 5.0)
166+
jekyll-remote-theme (0.4.3)
167+
addressable (~> 2.0)
168+
jekyll (>= 3.5, < 5.0)
169+
jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
170+
rubyzip (>= 1.3.0, < 3.0)
171+
jekyll-sass-converter (1.5.2)
172+
sass (~> 3.4)
173+
jekyll-seo-tag (2.8.0)
174+
jekyll (>= 3.8, < 5.0)
175+
jekyll-sitemap (1.4.0)
176+
jekyll (>= 3.7, < 5.0)
177+
jekyll-swiss (1.0.0)
178+
jekyll-theme-architect (0.2.0)
179+
jekyll (> 3.5, < 5.0)
180+
jekyll-seo-tag (~> 2.0)
181+
jekyll-theme-cayman (0.2.0)
182+
jekyll (> 3.5, < 5.0)
183+
jekyll-seo-tag (~> 2.0)
184+
jekyll-theme-dinky (0.2.0)
185+
jekyll (> 3.5, < 5.0)
186+
jekyll-seo-tag (~> 2.0)
187+
jekyll-theme-hacker (0.2.0)
188+
jekyll (> 3.5, < 5.0)
189+
jekyll-seo-tag (~> 2.0)
190+
jekyll-theme-leap-day (0.2.0)
191+
jekyll (> 3.5, < 5.0)
192+
jekyll-seo-tag (~> 2.0)
193+
jekyll-theme-merlot (0.2.0)
194+
jekyll (> 3.5, < 5.0)
195+
jekyll-seo-tag (~> 2.0)
196+
jekyll-theme-midnight (0.2.0)
197+
jekyll (> 3.5, < 5.0)
198+
jekyll-seo-tag (~> 2.0)
199+
jekyll-theme-minimal (0.2.0)
200+
jekyll (> 3.5, < 5.0)
201+
jekyll-seo-tag (~> 2.0)
202+
jekyll-theme-modernist (0.2.0)
203+
jekyll (> 3.5, < 5.0)
204+
jekyll-seo-tag (~> 2.0)
205+
jekyll-theme-primer (0.6.0)
206+
jekyll (> 3.5, < 5.0)
207+
jekyll-github-metadata (~> 2.9)
208+
jekyll-seo-tag (~> 2.0)
209+
jekyll-theme-slate (0.2.0)
210+
jekyll (> 3.5, < 5.0)
211+
jekyll-seo-tag (~> 2.0)
212+
jekyll-theme-tactile (0.2.0)
213+
jekyll (> 3.5, < 5.0)
214+
jekyll-seo-tag (~> 2.0)
215+
jekyll-theme-time-machine (0.2.0)
216+
jekyll (> 3.5, < 5.0)
217+
jekyll-seo-tag (~> 2.0)
218+
jekyll-titles-from-headings (0.5.3)
219+
jekyll (>= 3.3, < 5.0)
220+
jekyll-watch (2.2.1)
221+
listen (~> 3.0)
222+
jemoji (0.13.0)
223+
gemoji (>= 3, < 5)
224+
html-pipeline (~> 2.2)
225+
jekyll (>= 3.0, < 5.0)
226+
json (2.9.1)
227+
kramdown (2.4.0)
228+
rexml
229+
kramdown-parser-gfm (1.1.0)
230+
kramdown (~> 2.0)
231+
liquid (4.0.4)
232+
listen (3.9.0)
233+
rb-fsevent (~> 0.10, >= 0.10.3)
234+
rb-inotify (~> 0.9, >= 0.9.10)
235+
logger (1.6.5)
236+
mercenary (0.3.6)
237+
minima (2.5.1)
238+
jekyll (>= 3.5, < 5.0)
239+
jekyll-feed (~> 0.9)
240+
jekyll-seo-tag (~> 2.1)
241+
minitest (5.25.4)
242+
net-http (0.6.0)
243+
uri
244+
nokogiri (1.18.2-aarch64-linux-gnu)
245+
racc (~> 1.4)
246+
nokogiri (1.18.2-aarch64-linux-musl)
247+
racc (~> 1.4)
248+
nokogiri (1.18.2-arm-linux-gnu)
249+
racc (~> 1.4)
250+
nokogiri (1.18.2-arm-linux-musl)
251+
racc (~> 1.4)
252+
nokogiri (1.18.2-arm64-darwin)
253+
racc (~> 1.4)
254+
nokogiri (1.18.2-x86_64-darwin)
255+
racc (~> 1.4)
256+
nokogiri (1.18.2-x86_64-linux-gnu)
257+
racc (~> 1.4)
258+
nokogiri (1.18.2-x86_64-linux-musl)
259+
racc (~> 1.4)
260+
octokit (4.25.1)
261+
faraday (>= 1, < 3)
262+
sawyer (~> 0.9)
263+
pathutil (0.16.2)
264+
forwardable-extended (~> 2.6)
265+
public_suffix (5.1.1)
266+
racc (1.8.1)
267+
rb-fsevent (0.11.2)
268+
rb-inotify (0.11.1)
269+
ffi (~> 1.0)
270+
rexml (3.4.0)
271+
rouge (3.30.0)
272+
rubyzip (2.4.1)
273+
safe_yaml (1.0.5)
274+
sass (3.7.4)
275+
sass-listen (~> 4.0.0)
276+
sass-listen (4.0.0)
277+
rb-fsevent (~> 0.9, >= 0.9.4)
278+
rb-inotify (~> 0.9, >= 0.9.7)
279+
sawyer (0.9.2)
280+
addressable (>= 2.3.5)
281+
faraday (>= 0.17.3, < 3)
282+
securerandom (0.4.1)
283+
simpleidn (0.2.3)
284+
terminal-table (1.8.0)
285+
unicode-display_width (~> 1.1, >= 1.1.1)
286+
typhoeus (1.4.1)
287+
ethon (>= 0.9.0)
288+
tzinfo (2.0.6)
289+
concurrent-ruby (~> 1.0)
290+
unicode-display_width (1.8.0)
291+
uri (1.0.2)
292+
webrick (1.9.1)
293+
294+
PLATFORMS
295+
aarch64-linux-gnu
296+
aarch64-linux-musl
297+
arm-linux-gnu
298+
arm-linux-musl
299+
arm64-darwin
300+
x86_64-darwin
301+
x86_64-linux-gnu
302+
x86_64-linux-musl
303+
304+
DEPENDENCIES
305+
github-pages
306+
307+
BUNDLED WITH
308+
2.5.18

‎docs/_config.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
title: Roo Code Documentation
2+
description: Documentation for the Roo Code project
3+
remote_theme: just-the-docs/just-the-docs
4+
5+
url: https://docs.roocode.com
6+
7+
aux_links:
8+
"Roo Code on GitHub":
9+
- "//github.com/RooVetGit/Roo-Code"
10+
11+
# Enable search
12+
search_enabled: true
13+
14+
# Enable dark mode
15+
color_scheme: dark

‎docs/getting-started/index.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Getting Started
3+
layout: default
4+
nav_order: 2
5+
has_children: true
6+
---
7+
8+
# Getting Started with Roo Code
9+
10+
This section will help you get up and running with Roo Code quickly.

0 commit comments

Comments
 (0)