From 0b0334ad0d6a1a0eac81d6d93ea39125cb16a383 Mon Sep 17 00:00:00 2001 From: Adam Cohen Hillel Date: Mon, 12 Feb 2024 14:07:01 -0500 Subject: [PATCH] theme --- .gitignore | 16 +++++++ docs/Gemfile | 7 +++ docs/Gemfile.lock | 85 +++++++++++++++++++++++++++++++++++ docs/_config.yml | 8 ++++ docs/archive/launch_readme.md | 8 ++-- 5 files changed, 120 insertions(+), 4 deletions(-) create mode 100644 docs/Gemfile create mode 100644 docs/Gemfile.lock create mode 100644 docs/_config.yml diff --git a/.gitignore b/.gitignore index 4a148a9..84166e6 100644 --- a/.gitignore +++ b/.gitignore @@ -51,3 +51,19 @@ ios/App/fastlane/Appfile # pycache: __pycache__/ + +# Not sure what a .gitignore is? +# See: https://git-scm.com/docs/gitignore + +# These are directly copied from Jekyll's first-party docs on `.gitignore` files: +# https://jekyllrb.com/tutorials/using-jekyll-with-bundler/#commit-to-source-control + +# Ignore the default location of the built site, and caches and metadata generated by Jekyll +_site/ +.sass-cache/ +.jekyll-cache/ +.jekyll-metadata + +# Ignore folders generated by Bundler +.bundle/ +vendor/ \ No newline at end of file diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 0000000..d526ffb --- /dev/null +++ b/docs/Gemfile @@ -0,0 +1,7 @@ +source 'https://rubygems.org' + +gem "jekyll", "~> 4.3.3" # installed by `gem jekyll` +# gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2 + +gem "just-the-docs", "0.7.0" # pinned to the current release +# gem "just-the-docs" # always download the latest release \ No newline at end of file diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock new file mode 100644 index 0000000..ccbab01 --- /dev/null +++ b/docs/Gemfile.lock @@ -0,0 +1,85 @@ +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.2) + 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.1-arm64-darwin) + google-protobuf (3.25.1-x86_64-linux) + http_parser.rb (0.8.0) + i18n (1.14.1) + 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.7.0) + 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.8.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.0.6) + 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.69.5-arm64-darwin) + google-protobuf (~> 3.23) + sass-embedded (1.69.5-x86_64-linux-gnu) + google-protobuf (~> 3.23) + terminal-table (3.0.2) + unicode-display_width (>= 1.1.1, < 3) + unicode-display_width (2.5.0) + webrick (1.8.1) + +PLATFORMS + arm64-darwin-23 + x86_64-linux + +DEPENDENCIES + jekyll (~> 4.3.3) + just-the-docs (= 0.7.0) + +BUNDLED WITH + 2.3.26 \ No newline at end of file diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000..ba68977 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,8 @@ +title: Adeus Documentation +description: Open Source AI Wearable device +theme: just-the-docs + +url: https://just-the-docs.github.io + +aux_links: + Template Repository: https://github.com/just-the-docs/just-the-docs-template diff --git a/docs/archive/launch_readme.md b/docs/archive/launch_readme.md index 56e3f0a..b190235 100644 --- a/docs/archive/launch_readme.md +++ b/docs/archive/launch_readme.md @@ -15,7 +15,7 @@ In the upcoming world of AI devices like [Tab](https://mytab.ai/), [Pin](https:/ - [Areas to Contribute](#areas-to-contribute) - [CTA for the Community](#cta-for-the-community) -![ADeus v0.1](docs/images/adeus_01.jpeg) +![ADeus v0.1](https://github.com/adamcohenhillel/ADeus/tree/main/docs/images/adeus_01.jpeg) > p.s. any contribution would be amazing, whether you know how to code, and want to jump straight in to the codebase, a hardware person who can help out, or just looking to support this project financially (can literally be $10) - please reach out to me on X/Twitter [@adamcohenhillel](https://twitter.com/adamcohenhillel) @@ -32,7 +32,7 @@ Adeus consists of 3 parts: - [!!] But more importantly - **it is open source, and you can choose to deploy and manage your own Supabase instance** - which us crucial for our mission: A truly open-source, personal AI. This will look something like: -![ADeus diagram](docs/images/adeus_diagram.png) +![ADeus diagram](https://github.com/adamcohenhillel/ADeus/tree/main/docs/images/adeus_diagram.png) ## Setup @@ -69,7 +69,7 @@ First, to learn more about the device, it is good to check out the [official doc Here is quick video showing how to "connect" the hardware pieces together, and install the software: -[![set up device video](docs/images/thumbnail_2.png)](https://youtu.be/_2KRSlpnXrA) +[![set up device video](https://github.com/adamcohenhillel/ADeus/tree/main/docs/images/thumbnail_2.png)](https://youtu.be/_2KRSlpnXrA) In the root folder of this repository, run the following commands, (which will download the Coral AI Micro Dev dependencies to your computer - note that it might take a few minutes): @@ -175,4 +175,4 @@ The pioneers of the personal computers, the internet, they all knew it - and tha Check out the Intro video: -[![set up device video](docs/images/thumbnail_1.png)](https://youtu.be/4CqEC2yLGQU) +[![set up device video](https://github.com/adamcohenhillel/ADeus/tree/main/docs/images/thumbnail_1.png)](https://youtu.be/4CqEC2yLGQU)