Skip to content

Worktrunk is a CLI for Git worktree management, designed for parallel AI agent workflows

Redesign social cards with horizontal layout (#522)

Maximilian Roosbf575aaaee90
diff --git a/.github/workflows/publish-docs.yaml b/.github/workflows/publish-docs.yaml
index 8f581dd3b..c989b517f 100644
--- a/.github/workflows/publish-docs.yaml
+++ b/.github/workflows/publish-docs.yaml
@@ -25,13 +25,12 @@ jobs:
with:
- - name: Fetch demo assets
+ - name: Fetch assets
env:
GH_TOKEN: ${{ github.token }}
run: |
gh repo clone max-sixty/worktrunk-assets /tmp/worktrunk-assets -- --depth 1
- mkdir -p docs/static/assets
- cp -r /tmp/worktrunk-assets/demos/* docs/static/assets/
+ cp -r /tmp/worktrunk-assets/assets docs/static/
- name: πŸ•·οΈ Build docs
run: zola build
diff --git a/.gitignore b/.gitignore
index 355c8f431..d0b9f14d1 100644
--- a/.gitignore
+++ b/.gitignore
@@ -15,3 +15,4 @@ test-results/
# Nix build outputs
/result
/result-*
+.fonts
diff --git a/.typos.toml b/.typos.toml
index d4a16e70e..b53a327c9 100644
--- a/.typos.toml
+++ b/.typos.toml
@@ -7,3 +7,5 @@ ba = "ba" # Part of commit hashes like e28e0ba
ede = "ede" # Part of commit hashes like ede2fd3
# ANSI escape codes in snapshots make is_main/is_current/is_previous look like "mis"
mis = "mis"
+# "PNGs" is correct (Portable Network Graphics plural)
+PNGs = "PNGs"
diff --git a/README.md b/README.md
index 00e837d68..85cdbf12b 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@ Worktrunk's three core commands make worktrees as easy as branches. Plus, Worktr
Scaling agents becomes trivial. A quick demo:
-![Worktrunk Demo](https://cdn.jsdelivr.net/gh/max-sixty/worktrunk-assets@main/demos/docs/light/wt-core.gif)
+![Worktrunk Demo](https://cdn.jsdelivr.net/gh/max-sixty/worktrunk-assets@main/assets/docs/light/wt-core.gif)
> ### πŸ“š Full documentation at [worktrunk.dev](https://worktrunk.dev) πŸ“š
@@ -89,7 +89,7 @@ git branch -d feat</pre></td>
A demo with some advanced features:
-![Worktrunk omnibus demo: multiple Claude agents in Zellij tabs with hooks, LLM commits, and merge workflow](https://raw.githubusercontent.com/max-sixty/worktrunk-assets/main/demos/docs/light/wt-zellij-omnibus.gif)
+![Worktrunk omnibus demo: multiple Claude agents in Zellij tabs with hooks, LLM commits, and merge workflow](https://raw.githubusercontent.com/max-sixty/worktrunk-assets/main/assets/docs/light/wt-zellij-omnibus.gif)
<!-- END AUTO-GENERATED -->
diff --git a/dev/build-social-cards b/dev/build-social-cards
new file mode 100755
index 000000000..582d4fe78
--- /dev/null
+++ b/dev/build-social-cards
@@ -0,0 +1,69 @@
+#!/usr/bin/env bash
+# Regenerate social card ONGs from SVG sources
+# Requires: rsvg-convert (from librsvg)
+# Fonts are downloaded automatically if not installed
+
+set -euo pipefail
+
+SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
+STATIC_DIR="$SCRIPT_DIR/../docs/static"
+OUTPUT_DIR="$STATIC_DIR/assets/social"
+FONT_DIR="$SCRIPT_DIR/../.fonts"
+
+# Download font from GitHub releases if not installed
+ensure_font() {
+ local name="$1"
+ local url="$2"
+
+ if fc-list | grep -qi "$name"; then
+ return 0
+ fi
+
+ echo "Downloading $name..."
+ mkdir -p "$FONT_DIR"
+ local zip="$FONT_DIR/${name// /_}.zip"
+ curl -fsSL "$url" -o "$zip"
+ unzip -qo "$zip" -d "$FONT_DIR"
+ rm "$zip"
+}
+
+# Font sources (GitHub releases)
+ensure_font "Inter" "https://github.com/rsms/inter/releases/download/v4.1/Inter-4.1.zip"
+ensure_font "Plus Jakarta Sans" "https://github.com/tokotype/PlusJakartaSans/releases/download/2.7.1/PlusJakartaSans-2.7.1.zip"
+
+# Create fontconfig that includes our downloaded fonts
+export FONTCONFIG_FILE="$FONT_DIR/fonts.conf"
+cat > "$FONT_DIR/fonts.conf" << EOF
+<?xml version="1.0"?>
+<!DOCTYPE fontconfig SYSTEM "urn:fontconfig:fonts.dtd">
+<fontconfig>
+ <dir>$FONT_DIR</dir>
+ <cachedir>$FONT_DIR/cache</cachedir>
+ <include ignore_missing="yes">/etc/fonts/fonts.conf</include>
+</fontconfig>
+EOF
+mkdir -p "$FONT_DIR/cache"
+
+# Rebuild font cache
+fc-cache -f "$FONT_DIR" 2>/dev/null
+
+# Verify fonts are available
+for font in "Inter" "Plus Jakarta Sans"; do
+ if ! fc-list : family | grep -qi "$font"; then
+ echo "Error: Font '$font' not found after download" >&2
+ exit 1
+ fi
+done
+
+mkdir -p "$OUTPUT_DIR"
+cd "$STATIC_DIR"
+echo "Building social cards..."
+
+# Open Graph card (1200x630)
+rsvg-convert social-card.svg -o "$OUTPUT_DIR/social-card.png"
+
+# GitHub card (1280x640)
+rsvg-convert github-social-card.svg -o "$OUTPUT_DIR/github-social-card.png"
+
+echo "Done:"
+ls -lh "$OUTPUT_DIR"/*.png
diff --git a/dev/fetch-assets b/dev/fetch-assets
index 5ba2aca30..02b100e78 100755
--- a/dev/fetch-assets
+++ b/dev/fetch-assets
@@ -1,16 +1,19 @@
#!/bin/bash
-# Fetch demo assets from worktrunk-assets repo for local development
+# Fetch assets from worktrunk-assets repo for local development
set -euo pipefail
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
REPO_ROOT="$(dirname "$SCRIPT_DIR")"
ASSETS_DIR="$REPO_ROOT/docs/static/assets"
-echo "Fetching demo assets..."
+echo "Fetching assets..."
rm -rf "$ASSETS_DIR"
mkdir -p "$ASSETS_DIR"
-curl -fsSL "https://github.com/max-sixty/worktrunk-assets/archive/refs/heads/main.tar.gz" \
- | tar -xz --strip-components=2 -C "$ASSETS_DIR" "worktrunk-assets-main/demos"
+# Download and extract
+TMPFILE=$(mktemp)
+curl -fsSL "https://github.com/max-sixty/worktrunk-assets/archive/refs/heads/main.tar.gz" -o "$TMPFILE"
+tar -xzf "$TMPFILE" --strip-components=2 -C "$ASSETS_DIR" "worktrunk-assets-main/assets"
+rm "$TMPFILE"
echo "Done. Assets in $ASSETS_DIR/"
diff --git a/dev/publish-assets b/dev/publish-assets
index afadce32f..f4d7d10f2 100755
--- a/dev/publish-assets
+++ b/dev/publish-assets
@@ -1,11 +1,11 @@
#!/bin/bash
-# Publish demo assets to the worktrunk-assets repo
+# Publish assets to the worktrunk-assets repo
set -euo pipefail
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
REPO_ROOT="$(dirname "$SCRIPT_DIR")"
ASSETS_REPO="$REPO_ROOT/../worktrunk-assets"
-DEMOS_DIR="$REPO_ROOT/docs/static/assets"
+LOCAL_ASSETS="$REPO_ROOT/docs/static/assets"
# Clone assets repo if needed
if [[ ! -d "$ASSETS_REPO/.git" ]]; then
@@ -27,26 +27,20 @@ if ! git pull --ff-only; then
exit 1
fi
-# Copy demo assets
-if [[ ! -d "$DEMOS_DIR" ]] || [[ -z "$(ls -A "$DEMOS_DIR")" ]]; then
- echo "No demo assets found. Build them first:"
- echo " ./docs/demos/build docs"
- exit 1
-fi
-
-rsync -av --delete "$DEMOS_DIR/" "$ASSETS_REPO/demos/"
+# Sync local assets to repo
+rsync -av --delete "$LOCAL_ASSETS/" "$ASSETS_REPO/assets/"
# Check for changes
-if git diff --quiet demos/; then
+if git diff --quiet; then
echo "No changes to publish"
exit 0
fi
# Commit and push
-git diff --stat demos/
-git add demos/
-git commit -m "Update demo assets"
+git diff --stat
+git add -A
+git commit -m "Update assets"
git push
echo ""
-echo "Published: https://github.com/max-sixty/worktrunk-assets/tree/main/demos"
+echo "Published: https://github.com/max-sixty/worktrunk-assets"
diff --git a/docs/CLAUDE.md b/docs/CLAUDE.md
index 746818897..202d1d46f 100644
--- a/docs/CLAUDE.md
+++ b/docs/CLAUDE.md
@@ -290,6 +290,25 @@ Deploy runs `fetch-assets` before building.
For detailed demo development guidelines (timing, debugging, environment setup), see `docs/demos/CLAUDE.md`.
+## Social card workflow
+
+Social cards follow the same assets pattern as demos.
+
+**Source files:**
+- `social-card.svg` (1200Γ—630) β€” Open Graph/Twitter link previews, referenced in `base.html`
+- `github-social-card.svg` (1280Γ—640) β€” GitHub repository preview, uploaded manually in repo Settings β†’ Social preview
+
+**To regenerate** (after changing tagline, logo, or layout):
+
+```bash
+./dev/build-social-cards # SVG β†’ PNG (downloads fonts if needed)
+./dev/publish-assets # Publish to assets repo
+```
+
+The build script automatically downloads Inter and Plus Jakarta Sans fonts from GitHub if not installed locally. Requires `rsvg-convert` (from librsvg).
+
+**Referenced in:** `docs/templates/base.html` (og:image, twitter:image meta tags)
+
### Light/dark theme variants
In markdown, use `<picture>` with media queries:
diff --git a/docs/static/github-social-card.png b/docs/static/github-social-card.png
deleted file mode 100644
index 137cdcb54..000000000
Binary files a/docs/static/github-social-card.png and /dev/null differ
diff --git a/docs/static/github-social-card.svg b/docs/static/github-social-card.svg
new file mode 100644
index 000000000..5226baa3d
--- /dev/null
+++ b/docs/static/github-social-card.svg
@@ -0,0 +1,32 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="1280" height="640" viewBox="0 0 1280 640">
+ <defs>
+ <radialGradient id="logoGlow" cx="30%" cy="50%" r="50%">
+ <stop offset="0%" stop-color="#d4a54a" stop-opacity="0.30"/>
+ <stop offset="35%" stop-color="#d4a54a" stop-opacity="0.12"/>
+ <stop offset="100%" stop-color="#d4a54a" stop-opacity="0"/>
+ </radialGradient>
+ </defs>
+
+ <!-- Background -->
+ <rect width="1280" height="640" fill="#faf9f7"/>
+ <rect width="1280" height="640" fill="url(#logoGlow)"/>
+
+ <!-- Logo -->
+ <image x="160" y="150" width="340" height="340" href="[email protected]"/>
+
+ <!-- Title -->
+ <text x="610" y="280"
+ font-family="Plus Jakarta Sans"
+ font-size="88" font-weight="700" fill="#1a1817"
+ letter-spacing="-0.02em">worktrunk</text>
+
+ <!-- Tagline -->
+ <text x="610" y="395"
+ font-family="Inter"
+ font-size="28" font-weight="400" fill="#78716c"
+ letter-spacing="0.01em">Git worktree management</text>
+ <text x="610" y="437"
+ font-family="Inter"
+ font-size="28" font-weight="400" fill="#78716c"
+ letter-spacing="0.01em">for parallel AI agent workflows</text>
+</svg>
diff --git a/docs/static/social-card.png b/docs/static/social-card.png
deleted file mode 100644
index da6b25518..000000000
Binary files a/docs/static/social-card.png and /dev/null differ
diff --git a/docs/static/social-card.svg b/docs/static/social-card.svg
new file mode 100644
index 000000000..a936479a4
--- /dev/null
+++ b/docs/static/social-card.svg
@@ -0,0 +1,32 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="1200" height="630" viewBox="0 0 1200 630">
+ <defs>
+ <radialGradient id="logoGlow" cx="30%" cy="50%" r="50%">
+ <stop offset="0%" stop-color="#d4a54a" stop-opacity="0.30"/>
+ <stop offset="35%" stop-color="#d4a54a" stop-opacity="0.12"/>
+ <stop offset="100%" stop-color="#d4a54a" stop-opacity="0"/>
+ </radialGradient>
+ </defs>
+
+ <!-- Background -->
+ <rect width="1200" height="630" fill="#faf9f7"/>
+ <rect width="1200" height="630" fill="url(#logoGlow)"/>
+
+ <!-- Logo -->
+ <image x="120" y="145" width="340" height="340" href="[email protected]"/>
+
+ <!-- Title -->
+ <text x="570" y="275"
+ font-family="Plus Jakarta Sans"
+ font-size="88" font-weight="700" fill="#1a1817"
+ letter-spacing="-0.02em">worktrunk</text>
+
+ <!-- Tagline -->
+ <text x="570" y="390"
+ font-family="Inter"
+ font-size="28" font-weight="400" fill="#78716c"
+ letter-spacing="0.01em">Git worktree management</text>
+ <text x="570" y="432"
+ font-family="Inter"
+ font-size="28" font-weight="400" fill="#78716c"
+ letter-spacing="0.01em">for parallel AI agent workflows</text>
+</svg>
diff --git a/docs/templates/base.html b/docs/templates/base.html
index 4e5bbd6e1..10a8a9b4b 100644
--- a/docs/templates/base.html
+++ b/docs/templates/base.html
@@ -79,7 +79,7 @@
<meta property="og:url" content="{{ current_url | default(value=config.base_url) }}">
<meta property="og:title" content="{% if page.title %}{{ page.title }} | {{ config.title }}{% else %}{{ config.title }}{% endif %}">
<meta property="og:description" content="{{ config.extra.site_description }}">
- <meta property="og:image" content="{{ config.base_url }}social-card.png">
+ <meta property="og:image" content="{{ config.base_url }}assets/social/social-card.png">
<meta property="og:image:width" content="1200">
<meta property="og:image:height" content="630">
@@ -87,7 +87,7 @@
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:title" content="{% if page.title %}{{ page.title }} | {{ config.title }}{% else %}{{ config.title }}{% endif %}">
<meta name="twitter:description" content="{{ config.extra.site_description }}">
- <meta name="twitter:image" content="{{ config.base_url }}social-card.png">
+ <meta name="twitter:image" content="{{ config.base_url }}assets/social/social-card.png">
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-6YY8BDJ4QH"></script>
diff --git a/tests/integration_tests/readme_sync.rs b/tests/integration_tests/readme_sync.rs
index 2459340f0..65c8086a0 100644
--- a/tests/integration_tests/readme_sync.rs
+++ b/tests/integration_tests/readme_sync.rs
@@ -101,7 +101,7 @@ static ZOLA_RAWCODE_PATTERN: LazyLock<Regex> =
/// Regex to convert Zola figure/picture elements to simple markdown images
/// Matches: <figure class="demo">...<img src="/assets/X.gif" alt="Y"...>...</figure>
/// Extracts: src path and alt text from the <img> tag
-/// Note: Maps /assets/X to demos/X in the worktrunk-assets repo
+/// Note: Maps /assets/X to assets/X in the worktrunk-assets repo
static ZOLA_FIGURE_PATTERN: LazyLock<Regex> = LazyLock::new(|| {
Regex::new(
r#"(?s)<figure class="demo">\s*<picture>.*?<img src="/assets/([^"]+)" alt="([^"]*)"[^>]*>.*?</picture>.*?</figure>"#,
@@ -769,7 +769,7 @@ fn transform_zola_to_github(content: &str) -> String {
let filename = caps.get(1).unwrap().as_str();
let alt = caps.get(2).unwrap().as_str();
format!(
- "![{alt}](https://raw.githubusercontent.com/max-sixty/worktrunk-assets/main/demos/{filename})"
+ "![{alt}](https://raw.githubusercontent.com/max-sixty/worktrunk-assets/main/assets/{filename})"
)
})
.into_owned()