Skip to main content

Demo Preview Guide

Two ways to preview AgentReady demo sites: Quick (slides only) or Full (Jekyll server with all demos).


Quick Preview (No Setup)

Fastest option - Just open the slides in your browser:

# macOS
open docs/demos/slides.html

# Linux
xdg-open docs/demos/slides.html

# Or manually: Double-click docs/demos/slides.html

What you’ll see:


Full Preview (Complete Experience)

Requires: Ruby, Bundler, Jekyll (see installation below)

Start Jekyll Server

# From repository root
make docs-serve

# OR manually:
cd docs
bundle exec jekyll serve --livereload

View Demos

Open in browser: http://localhost:4000/agentready/demos/

Available demos:

Features:

Stop Server

Press Ctrl+C in terminal


Installation (First Time Only)

macOS

# 1. Install Ruby via Homebrew
brew install ruby

# 2. Add to PATH (one-time)
echo 'export PATH="/opt/homebrew/opt/ruby/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

# 3. Install Bundler
gem install bundler

# 4. Install Jekyll dependencies
cd docs
bundle install

Ubuntu/Debian

# 1. Install Ruby
sudo apt-get install ruby-full build-essential

# 2. Configure gem path (avoid sudo)
echo 'export GEM_HOME="$HOME/gems"' >> ~/.bashrc
echo 'export PATH="$HOME/gems/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

# 3. Install Bundler
gem install bundler

# 4. Install Jekyll dependencies
cd docs
bundle install

Troubleshooting

Port 4000 already in use

# Find process using port 4000
lsof -i :4000

# Kill it
kill -9 <PID>

# Or use different port
bundle exec jekyll serve --port 4001

Mermaid diagrams not rendering

Slides keyboard navigation not working


Quick Commands

# Generate slides (if changed DEMO_SUMMARY.md)
make demo-slides

# Validate all demo files
make demo-validate

# Start Jekyll server
make docs-serve

# Open slides directly
open docs/demos/slides.html

Setup Date: 2025-12-07 Ruby: 3.4.7 (Homebrew) Jekyll: 3.9.5 Bundler: 2.5.23