Skip to content

Claude/fix docc GitHub pages urls 011 cv2q14o ul mhe eh tb hv hsq #26

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
SoundBlaster merged 3 commits into from
Nov 11, 2025
Merged

Claude/fix docc GitHub pages urls 011 cv2q14o ul mhe eh tb hv hsq #26

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3ec92cd
Add debug output to investigate DocC structure
claude Nov 11, 2025
d827d8b
Remove redirect, let DocC's index.html work natively
claude Nov 11, 2025
b3852d2
Fix DocC resource paths with sed (Xcode setting not sufficient)
claude Nov 11, 2025
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
114 changes: 56 additions & 58 deletions .github/workflows/docc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,68 +60,66 @@ jobs:
echo "=== Documentation processed for static hosting ==="
echo "Hosting base path: $DOCC_HOSTING_BASE_PATH"

- name: Add .nojekyll and root redirect
echo ""
echo "=== Directory structure ==="
find DocsBuild -type d | sort

echo ""
echo "=== Files in documentation directory ==="
find DocsBuild/documentation -type f 2>/dev/null | head -20 || echo "No documentation directory found"

echo ""
echo "=== Files in tutorials directory ==="
find DocsBuild/tutorials -type f 2>/dev/null | head -20 || echo "No tutorials directory found"

echo ""
echo "=== Root level files ==="
ls -la DocsBuild/

echo ""
echo "=== Index directory contents ==="
ls -la DocsBuild/index/ 2>/dev/null || echo "No index directory"

echo ""
echo "=== Data directory structure ==="
find DocsBuild/data -type f 2>/dev/null | head -10 || echo "No data directory"

echo ""
echo "=== metadata.json content ==="
cat DocsBuild/metadata.json 2>/dev/null || echo "No metadata.json"

echo ""
echo "=== Original index.html content ==="
cat DocsBuild/index.html

- name: Fix resource paths and add .nojekyll
run: |
# Add .nojekyll to prevent GitHub Pages from ignoring files starting with _
touch DocsBuild/.nojekyll

# Create redirect from root to documentation page
# The actual documentation lives at /documentation/<bundle-id>/
cat > DocsBuild/index.html << 'EOF'
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<title>Redirecting to NavigationSplitView Documentation</title>
<meta http-equiv="refresh" content="0; url=./documentation/navigationsplitview/">
<link rel="canonical" href="./documentation/navigationsplitview/">
<style>
body {
font-family: -apple-system, BlinkMacSystemFont, "SF Pro Display", "Segoe UI", Roboto, sans-serif;
display: flex;
align-items: center;
justify-content: center;
height: 100vh;
margin: 0;
background: #f5f5f7;
}
.container {
text-align: center;
padding: 2rem;
}
h1 {
font-size: 2rem;
font-weight: 600;
margin-bottom: 1rem;
color: #1d1d1f;
}
p {
font-size: 1.125rem;
color: #86868b;
}
a {
color: #0071e3;
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
</style>
</head>
<body>
<div class="container">
<h1>NavigationSplitView Documentation</h1>
<p>Redirecting to <a href="./documentation/navigationsplitview/">documentation</a>...</p>
</div>
<script>
window.location.href = "./documentation/navigationsplitview/";
</script>
</body>
</html>
EOF

echo "=== Created root redirect ==="
cat DocsBuild/index.html
# Fix resource paths in HTML files
# Even with DOCC_HOSTING_BASE_PATH in Xcode, DocC still generates absolute paths
echo "=== Fixing resource paths in HTML files ==="
find DocsBuild -type f -name "*.html" -exec sed -i '' \
-e 's|var baseUrl = "/"|var baseUrl = "/'$DOCC_HOSTING_BASE_PATH'/"|g' \
-e 's|src="/js/|src="/'$DOCC_HOSTING_BASE_PATH'/js/|g' \
-e 's|src="/css/|src="/'$DOCC_HOSTING_BASE_PATH'/css/|g' \
-e 's|href="/css/|href="/'$DOCC_HOSTING_BASE_PATH'/css/|g' \
-e 's|href="/favicon.ico"|href="/'$DOCC_HOSTING_BASE_PATH'/favicon.ico"|g' \
-e 's|href="/favicon.svg"|href="/'$DOCC_HOSTING_BASE_PATH'/favicon.svg"|g' \
{} +

# Fix paths in JavaScript files
echo "=== Fixing paths in JavaScript files ==="
find DocsBuild -type f -name "*.js" -exec sed -i '' \
-e 's|"/data/|"/'$DOCC_HOSTING_BASE_PATH'/data/|g' \
-e 's|"/tutorials/|"/'$DOCC_HOSTING_BASE_PATH'/tutorials/|g' \
-e 's|"/index/|"/'$DOCC_HOSTING_BASE_PATH'/index/|g' \
{} +
Comment on lines +103 to +118
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot Nov 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Patch JS rewrites miss root JSON and single-quoted URLs

The new sed invocation only rewrites double-quoted "/data/, "/tutorials/, and "/index/ strings, but DocC’s generated JavaScript also fetches assets via single-quoted paths and root-level JSON files such as theme-settings.json. Without rewriting those to include $DOCC_HOSTING_BASE_PATH, the browser still requests https://<user>.github.io/theme-settings.json and other /documentation/… resources from the site root, which yields 404s when the docs are hosted under /NavigationSplitView. Consider adding patterns for '...' paths and root JSON files (as previously done) so all asset URLs receive the base path.

Useful? React with 👍 / 👎.


echo "=== Fixed paths ==="
echo "Fixed index.html:"
head -5 DocsBuild/index.html

- name: Upload documentation artifact
if: github.event_name == 'push'
Expand Down