Skip to content

fix(ci): fix docs smoke test and setup comprehensive redirects #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ctreffs merged 3 commits into from
Feb 11, 2026
Merged

fix(ci): fix docs smoke test and setup comprehensive redirects #38

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c830f1a
fix(ci): update docs smoke test to check for 'Documentation' instead …
ctreffs Feb 11, 2026
97d4f6b
feat(ci): setup comprehensive documentation redirects (root -> latest…
ctreffs Feb 11, 2026
76f0c57
chore: refresh PR
ctreffs Feb 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 39 additions & 10 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,25 +33,54 @@ jobs:
- name: Build Documentation
run: make docs-generate REPO_NAME=math DOCS_VERSION_PATH=main

- name: Add Root Redirect
- name: Setup Redirects
run: |
cat <<EOF > .build/documentation/index.html
# Function to create a redirect file
create_redirect() {
local FILE_PATH=$1
local TARGET_URL=$2
local TITLE=$3

mkdir -p "$(dirname "$FILE_PATH")"

cat <<EOF > "$FILE_PATH"
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Redirecting to Documentation</title>
<link rel="canonical" href="main/documentation/fireblademath/index.html">
<title>$TITLE</title>
<link rel="canonical" href="$TARGET_URL">
<script>
window.location.href = "main/documentation/fireblademath/index.html" + window.location.hash;
window.location.href = "$TARGET_URL" + window.location.hash;
</script>
<meta http-equiv="refresh" content="0;url=main/documentation/fireblademath/index.html">
<meta http-equiv="refresh" content="0;url=$TARGET_URL">
</head>
<body>
<p>Redirecting to <a href="main/documentation/fireblademath/index.html">documentation</a>...</p>
<p>Redirecting to <a href="$TARGET_URL">$TITLE</a>...</p>
</body>
</html>
EOF
}

# 1. Root -> latest/documentation/fireblademath/
create_redirect ".build/documentation/index.html" \
"latest/documentation/fireblademath/index.html" \
"Redirecting to Latest Docs"

# 2. latest/ -> main/documentation/fireblademath/
create_redirect ".build/documentation/latest/index.html" \
"../main/documentation/fireblademath/index.html" \
"Redirecting to Main Docs"

# 3. latest/documentation/fireblademath/ -> main/documentation/fireblademath/
create_redirect ".build/documentation/latest/documentation/fireblademath/index.html" \
"../../../main/documentation/fireblademath/index.html" \
"Redirecting to Main Docs"

# 4. documentation/fireblademath/ -> main/documentation/fireblademath/
create_redirect ".build/documentation/documentation/fireblademath/index.html" \
"../../main/documentation/fireblademath/index.html" \
"Redirecting to Main Docs"

- name: Check Documentation Quality
run: |
Expand Down Expand Up @@ -86,7 +115,7 @@ jobs:
# Wait a few seconds for CDN propagation
sleep 10
# Verify the versioned documentation path exists
curl --fail -sL https://fireblade-engine.github.io/math/main/documentation/fireblademath/ | grep -q "FirebladeMath"
curl --fail -sL https://fireblade-engine.github.io/math/main/documentation/fireblademath/ | grep -q "Documentation"
echo "Documentation is live at /math/main/"

- name: Check Root Redirect
Expand All @@ -95,5 +124,5 @@ jobs:
RESPONSE=$(curl -sI https://fireblade-engine.github.io/math/ | head -n 1)
# Note: GitHub Pages might return 200 with the redirect meta tag, or a 301/302 if configured at the DNS level.
# Since we use a meta/JS redirect, we check for a 200 OK and then the content.
curl -s https://fireblade-engine.github.io/math/ | grep -q "Redirecting to"
echo "Root redirect is live at /math/"
curl -s https://fireblade-engine.github.io/math/ | grep -q "Redirecting to Latest Docs"
echo "Root redirect is live at /math/ and points to latest docs"