feat: switch to Just the Docs theme for better documentation UX

Author: christoph2806

docs/Gemfile

@@ -1,18 +1,12 @@
 source "https://rubygems.org"
 
 gem "jekyll", "~> 4.3.0"
-gem "minimal-mistakes-jekyll"
-gem "jekyll-feed"
-gem "jekyll-sitemap"
-gem "jekyll-gist"
-gem "jekyll-include-cache"
-gem "jekyll-seo-tag"
+gem "just-the-docs"
 
-group :jekyll_plugins do
-  gem "jekyll-paginate"
-  gem "jekyll-archives"
-  gem "jekyll-redirect-from"
-end
+# Jekyll plugins
+gem "jekyll-seo-tag"
+gem "jekyll-sitemap"
+gem "jekyll-feed"
 
 # Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
 # and associated library.

docs/_config.yml

@@ -4,164 +4,105 @@ description: "Secure command validation and analysis for development workflows"
 url: "https://etherisc.github.io"
 baseurl: "/ai-command-auditor"
 
-# Site author
-author:
-  name: "Etherisc"
-  bio: "Decentralized insurance protocols and development tools"
-  avatar: "/assets/images/avatar.jpg"
-  links:
-    - label: "GitHub"
-      icon: "fab fa-fw fa-github"
-      url: "https://github.com/etherisc"
+# Theme
+remote_theme: just-the-docs/just-the-docs
+
+# Color scheme
+color_scheme: light
 
-# Theme and appearance
-remote_theme: "mmistakes/minimal-mistakes"
-minimal_mistakes_skin: "default"
+# Logo and favicon
+logo: "/assets/images/logo.png"
 
-# Reading settings
-markdown: kramdown
-highlighter: rouge
-lsi: false
-excerpt_separator: "\n\n"
-incremental: false
+# Search
+search_enabled: true
+search:
+  heading_level: 2
+  previews: 3
+  preview_words_before: 5
+  preview_words_after: 10
+  tokenizer_separator: /[\s/]+/
+  rel_url: true
+  button: false
+
+# Navigation
+nav_sort: case_insensitive
+
+# Aux links (top right)
+aux_links:
+  "GitHub Repository":
+    - "https://github.com/etherisc/ai-command-auditor"
+  "Quick Install":
+    - "/installation"
+
+aux_links_new_tab: true
+
+# Footer
+footer_content: "Copyright &copy; 2024 Etherisc. Distributed under the <a href=\"https://github.com/etherisc/ai-command-auditor/blob/main/LICENSE\">MIT License</a>."
+
+# Back to top link
+back_to_top: true
+back_to_top_text: "Back to top"
+
+# Last edit timestamp
+last_edit_timestamp: true
+last_edit_time_format: "%b %e %Y at %I:%M %p"
+
+# Git repository info
+gh_edit_link: true
+gh_edit_link_text: "Edit this page on GitHub"
+gh_edit_repository: "https://github.com/etherisc/ai-command-auditor"
+gh_edit_branch: "main"
+gh_edit_source: docs
+gh_edit_view_mode: "tree"
+
+# Callouts
+callouts_level: quiet
+callouts:
+  highlight:
+    color: yellow
+  new:
+    title: New
+    color: green
+  note:
+    title: Note
+    color: blue
+  warning:
+    title: Warning
+    color: red
+
+# Mermaid diagrams
+mermaid:
+  version: "9.1.3"
 
 # Plugins
 plugins:
-  - jekyll-paginate
+  - jekyll-seo-tag
   - jekyll-sitemap
-  - jekyll-gist
   - jekyll-feed
-  - jekyll-include-cache
-  - jekyll-seo-tag
-
-# Analytics
-analytics:
-  provider: false
-
-# Search
-search: true
-search_full_content: true
 
 # SEO
-logo: "/assets/images/logo.png"
-og_image: "/assets/images/ai-auditor-og.png"
+author:
+  name: "Etherisc"
+  url: "https://github.com/etherisc"
 
-# Social
 social:
-  type: Organization
   name: Etherisc
   links:
-    - "https://github.com/etherisc"
-
-# Main navigation
-main:
-  - title: "Installation"
-    url: /installation
-  - title: "Configuration"
-    url: /configuration
-  - title: "API Reference"
-    url: /api
-  - title: "Examples"
-    url: /examples
-  - title: "Support"
-    url: /support
-  - title: "GitHub"
-    url: "https://github.com/etherisc/ai-command-auditor"
-
-# Sidebar navigation for docs
-sidebar:
-  nav: "docs"
-
-# Documentation navigation
-docs:
-  - title: Getting Started
-    children:
-      - title: "Installation Guide"
-        url: /installation
-      - title: "Installation Methods"
-        url: /installation/methods
-
-  - title: Configuration
-    children:
-      - title: "Configuration Overview"
-        url: /configuration
-      - title: "Security Rules"
-        url: /configuration/security-rules
-      - title: "AI Prompts"
-        url: /configuration/ai-prompts
-
-  - title: API Reference
-    children:
-      - title: "CLI Commands"
-        url: /api/cli
-      - title: "Python API"
-        url: /api/python
-
-  - title: Examples
-    children:
-      - title: "Getting Started Tutorial"
-        url: /examples/tutorial
-
-  - title: Support
-    children:
-      - title: "Support Overview"
-        url: /support
-
-# Defaults
-defaults:
-  # _posts
-  - scope:
-      path: ""
-      type: posts
-    values:
-      layout: single
-      author_profile: true
-      read_time: true
-      comments: false
-      share: true
-      related: true
-      sidebar:
-        nav: "docs"
-
-  # _pages (all markdown files)
-  - scope:
-      path: ""
-      type: pages
-    values:
-      layout: single
-      author_profile: false
-      sidebar:
-        nav: "docs"
-
-# Pagination
-paginate: 5
-paginate_path: /page:num/
-
-# Archives
-category_archive:
-  type: liquid
-  path: /categories/
-tag_archive:
-  type: liquid
-  path: /tags/
-
-# HTML Compression
-compress_html:
-  clippings: all
-  ignore:
-    envs: development
+    - https://github.com/etherisc
 
 # Exclude from processing
 exclude:
-  - .sass-cache/
-  - .jekyll-cache/
-  - gemfiles/
+  - node_modules/
+  - "*.gemspec"
+  - "*.gem"
   - Gemfile
   - Gemfile.lock
-  - node_modules/
-  - vendor/bundle/
-  - vendor/cache/
-  - vendor/gems/
-  - vendor/ruby/
-  - "*.sh"
+  - package.json
+  - package-lock.json
+  - script/
+  - LICENSE.txt
+  - lib/
+  - bin/
   - README.md
+  - Rakefile
+  - docs/tests/