[docs] Migrate opencue.io documentation into main OpenCue repo with Jekyll, GitHub Pages, modern UI, dark mode, and tutorial enhancements (#1784)

Migrated all documentation from the [opencue.io](https://www.opencue.io/) [repository](https://github.com/AcademySoftwareFoundation/opencue.io) into a new `/docs` directory in the main OpenCue codebase. Rebuilt the site using Jekyll with the [Just the Docs](https://github.com/just-the-docs/just-the-docs) theme improved and adapted and enabled automated deployment via GitHub Actions.

Linked Issue:
- #1667

---

Documentation infrastructure:
- Jekyll-based site with structured content and custom OpenCue branding
- GitHub Actions workflow for GitHub Pages deployment
- [Lunr.js](https://lunrjs.com/) search with live highlighting and excerpts

Search features:
- Real-time search results as you type
- Indexed content across all pages
- Keyboard shortcut support: `Ctrl+K` (Windows/Linux) or `⌘+K` (Mac)

Content migration:
- Converted all docs from [opencue.io](https://www.opencue.io/)
- Adapted Hugo shortcodes and YAML front matter to Jekyll
- Organized navigation into clear, categorized sections
- Added new tutorials and a Windows quick start guide

New tutorials:
- **Getting started with OpenCue:** Core concepts and basic job submission
- **Submitting your first Opencue job:** PyOutline scripting and CueSubmit usage
- **Using CueGUI for job monitoring:** Interface walkthrough and controls
- **Managing jobs and frames:** Advanced workflows and troubleshooting
- **Creating multi-layer jobs:** Dependencies and complex pipelines
- **DCC integration:** Setup for Maya, Blender, Nuke, and Houdini

Each tutorial includes:
- Practical code examples based on real OpenCue components
- Best practices from the codebase
- Troubleshooting guidance
- Progressive learning flow
- Cross-references between topics

Dark Mode & Theme toggle support:
- Added dark theme with improved contrast and readability via `_sass/color_schemes`
- Theme toggle button (moon / sun) added to `aux-nav.html`
- Created a theme toggle navigation link above the "Home" link for toggling between light and dark modes
- Theme preference saved via `localStorage` and respects system settings
- Script injected in `header_custom.html` to prevent white flash on load
- Enhanced auxiliary nav layout for consistent light/dark UI
- Smooth transitions and ARIA-compliant accessibility

---

The new documentation site features a responsive, modern design with improved navigation, dark mode support, versioning capabilities, and comprehensive tutorials for both new and experienced users.

To view the original contributors to the [opencue.io](https://www.opencue.io/) documentation (Feb 7, 2019 – Feb 6, 2025), see:  
https://github.com/AcademySoftwareFoundation/opencue.io/graphs/contributors

Author: ramonfigueiredo

.github/workflows/docs.yml

@@ -0,0 +1,76 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - master
+      - main
+    paths:
+      - 'docs/**'
+      - '.github/workflows/docs.yml'
+  pull_request:
+    paths:
+      - 'docs/**'
+      - '.github/workflows/docs.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Fetch all history for versioning
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.2'
+          bundler-cache: true
+          working-directory: ./docs
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v4
+        if: github.event_name != 'pull_request'
+
+      - name: Build with Jekyll
+        working-directory: ./docs
+        run: |
+          if [ "${{ github.event_name }}" = "pull_request" ]; then
+            bundle exec jekyll build --baseurl "/OpenCue"
+          else
+            bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+          fi
+        env:
+          JEKYLL_ENV: production
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        if: github.event_name != 'pull_request'
+        with:
+          path: ./docs/_site
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main'
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -27,3 +27,4 @@ cuebot/.project
 /pycue/opencue/compiled_proto/
 /rqd/rqd/compiled_proto/
 docker-compose-local.yml
+docs/_site/

docs/404.md

@@ -0,0 +1,38 @@
+---
+layout: default
+title: 404 - Page not found
+permalink: /404.html
+nav_exclude: true
+search_exclude: true
+---
+
+# 404 - Page not found
+{: .fs-9 }
+
+Sorry, we couldn't find the page you're looking for.
+{: .fs-6 .fw-300 }
+
+The page you requested might have been moved, removed, or does not exist. Please check the URL or use the navigation menu to find what you're looking for.
+
+[Go to homepage]({{ site.baseurl }}/){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 }
+[View all docs]({{ site.baseurl }}/docs/){: .btn .fs-5 .mb-4 .mb-md-0 }
+
+---
+
+## Popular Pages
+
+You might be looking for one of these popular pages:
+
+- [OpenCue Overview]({{ site.baseurl }}/docs/concepts/opencue-overview/)
+- [Quick Start for Linux]({{ site.baseurl }}/docs/quick-starts/quick-start-linux/)
+- [Quick Start for macOS]({{ site.baseurl }}/docs/quick-starts/quick-start-mac/)
+- [Quick Start for Windows]({{ site.baseurl }}/docs/quick-starts/quick-start-windows/)
+
+## Need Help?
+
+If you can't find what you're looking for:
+
+- Check out our [documentation index]({{ site.baseurl }}/docs/)
+- Search for content using the search bar above
+- [Report an issue](https://github.com/AcademySoftwareFoundation/OpenCue/issues) on GitHub
+- Join the [Opencue Slack channel](https://academysoftwarefdn.slack.com/archives/CMFPXV39Q).

docs/Gemfile

@@ -0,0 +1,23 @@
+source "https://rubygems.org"
+
+gem "jekyll", "~> 4.3"
+gem "just-the-docs", "~> 0.7.0"
+gem "jekyll-seo-tag", "~> 2.8"
+gem "jekyll-github-metadata", "~> 2.16"
+gem "jekyll-include-cache", "~> 0.2"
+gem "jekyll-sitemap", "~> 1.4"
+
+# GitHub Pages plugins
+group :jekyll_plugins do
+  gem "jekyll-feed", "~> 0.17"
+  gem "jekyll-redirect-from", "~> 0.16"
+  gem "jekyll-relative-links", "~> 0.6"
+  gem "jekyll-optional-front-matter", "~> 0.3"
+  gem "jekyll-titles-from-headings", "~> 0.5"
+end
+
+# Development dependencies
+group :development do
+  gem "webrick", "~> 1.8"
+  gem "rake", "~> 13.0"
+end

docs/Gemfile.lock

@@ -0,0 +1,213 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    base64 (0.3.0)
+    bigdecimal (3.2.2)
+    colorator (1.1.0)
+    concurrent-ruby (1.3.5)
+    csv (3.3.5)
+    em-websocket (0.5.3)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0)
+    eventmachine (1.2.7)
+    faraday (2.13.4)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-net_http (3.4.1)
+      net-http (>= 0.5.0)
+    ffi (1.17.2)
+    ffi (1.17.2-aarch64-linux-gnu)
+    ffi (1.17.2-aarch64-linux-musl)
+    ffi (1.17.2-arm-linux-gnu)
+    ffi (1.17.2-arm-linux-musl)
+    ffi (1.17.2-arm64-darwin)
+    ffi (1.17.2-x86-linux-gnu)
+    ffi (1.17.2-x86-linux-musl)
+    ffi (1.17.2-x86_64-darwin)
+    ffi (1.17.2-x86_64-linux-gnu)
+    ffi (1.17.2-x86_64-linux-musl)
+    forwardable-extended (2.6.0)
+    google-protobuf (4.31.1)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.31.1-aarch64-linux-gnu)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.31.1-aarch64-linux-musl)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.31.1-arm64-darwin)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.31.1-x86-linux-gnu)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.31.1-x86-linux-musl)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.31.1-x86_64-darwin)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.31.1-x86_64-linux-gnu)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.31.1-x86_64-linux-musl)
+      bigdecimal
+      rake (>= 13)
+    http_parser.rb (0.8.0)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.4.1)
+      addressable (~> 2.4)
+      base64 (~> 0.2)
+      colorator (~> 1.0)
+      csv (~> 3.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (>= 2.0, < 4.0)
+      jekyll-watch (~> 2.0)
+      json (~> 2.6)
+      kramdown (~> 2.3, >= 2.3.1)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (~> 0.3, >= 0.3.6)
+      pathutil (~> 0.9)
+      rouge (>= 3.0, < 5.0)
+      safe_yaml (~> 1.0)
+      terminal-table (>= 1.8, < 4.0)
+      webrick (~> 1.7)
+    jekyll-feed (0.17.0)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-github-metadata (2.16.1)
+      jekyll (>= 3.4, < 5.0)
+      octokit (>= 4, < 7, != 4.4.0)
+    jekyll-include-cache (0.2.1)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-optional-front-matter (0.3.2)
+      jekyll (>= 3.0, < 5.0)
+    jekyll-redirect-from (0.16.0)
+      jekyll (>= 3.3, < 5.0)
+    jekyll-relative-links (0.7.0)
+      jekyll (>= 3.3, < 5.0)
+    jekyll-sass-converter (3.1.0)
+      sass-embedded (~> 1.75)
+    jekyll-seo-tag (2.8.0)
+      jekyll (>= 3.8, < 5.0)
+    jekyll-sitemap (1.4.0)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-titles-from-headings (0.5.3)
+      jekyll (>= 3.3, < 5.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    json (2.13.2)
+    just-the-docs (0.7.0)
+      jekyll (>= 3.8.5)
+      jekyll-include-cache
+      jekyll-seo-tag (>= 2.0)
+      rake (>= 12.3.1)
+    kramdown (2.5.1)
+      rexml (>= 3.3.9)
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.4)
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.7.0)
+    mercenary (0.4.0)
+    net-http (0.6.0)
+      uri
+    octokit (6.1.1)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (6.0.2)
+    rake (13.3.0)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    rexml (3.4.1)
+    rouge (4.6.0)
+    safe_yaml (1.0.5)
+    sass-embedded (1.89.2)
+      google-protobuf (~> 4.31)
+      rake (>= 13)
+    sass-embedded (1.89.2-aarch64-linux-android)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-aarch64-linux-gnu)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-aarch64-linux-musl)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-arm-linux-androideabi)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-arm-linux-gnueabihf)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-arm-linux-musleabihf)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-arm64-darwin)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-riscv64-linux-android)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-riscv64-linux-gnu)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-riscv64-linux-musl)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-x86_64-darwin)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-x86_64-linux-android)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-x86_64-linux-gnu)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-x86_64-linux-musl)
+      google-protobuf (~> 4.31)
+    sawyer (0.9.2)
+      addressable (>= 2.3.5)
+      faraday (>= 0.17.3, < 3)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    unicode-display_width (2.6.0)
+    uri (1.0.3)
+    webrick (1.9.1)
+
+PLATFORMS
+  aarch64-linux-android
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-androideabi
+  arm-linux-gnu
+  arm-linux-gnueabihf
+  arm-linux-musl
+  arm-linux-musleabihf
+  arm64-darwin
+  riscv64-linux-android
+  riscv64-linux-gnu
+  riscv64-linux-musl
+  ruby
+  x86-linux-gnu
+  x86-linux-musl
+  x86_64-darwin
+  x86_64-linux-android
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  jekyll (~> 4.3)
+  jekyll-feed (~> 0.17)
+  jekyll-github-metadata (~> 2.16)
+  jekyll-include-cache (~> 0.2)
+  jekyll-optional-front-matter (~> 0.3)
+  jekyll-redirect-from (~> 0.16)
+  jekyll-relative-links (~> 0.6)
+  jekyll-seo-tag (~> 2.8)
+  jekyll-sitemap (~> 1.4)
+  jekyll-titles-from-headings (~> 0.5)
+  just-the-docs (~> 0.7.0)
+  rake (~> 13.0)
+  webrick (~> 1.8)
+
+BUNDLED WITH
+   2.6.9