Skip to content

Fix DocC path renaming to preserve doc:// identifiers #3

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

Open
paduh wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix DocC path renaming to preserve doc:// identifiers #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
135 changes: 54 additions & 81 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,98 +77,71 @@ jobs:

cat > /tmp/fix_colons.py << 'PYTHON_EOF'
import os
import json
import glob
import re
from pathlib import Path

def rename_files_with_colons(root_dir):
"""Recursively rename all files and directories containing colons"""
renamed_count = 0

# First, rename directories (must be done depth-first)
for root, dirs, files in os.walk(root_dir, topdown=False):
for dirname in dirs:
if ':' in dirname:
old_path = os.path.join(root, dirname)
new_dirname = dirname.replace(':', '-')
new_path = os.path.join(root, new_dirname)
print(f"Renaming directory: {old_path} -> {new_path}")
os.rename(old_path, new_path)
renamed_count += 1

# Then rename files
for root, dirs, files in os.walk(root_dir):
for filename in files:
if ':' in filename:
old_path = os.path.join(root, filename)
new_filename = filename.replace(':', '-')
new_path = os.path.join(root, new_filename)
print(f"Renaming file: {old_path} -> {new_path}")
os.rename(old_path, new_path)
renamed_count += 1

print(f"Renamed {renamed_count} files/directories")
return renamed_count

def fix_json_paths(obj):
"""Recursively fix path strings in JSON object by replacing : with -"""
if isinstance(obj, dict):
return {k: fix_json_paths(v) for k, v in obj.items()}
elif isinstance(obj, list):
return [fix_json_paths(item) for item in obj]
elif isinstance(obj, str):
# Replace colons in strings that look like paths or URLs
# Match paths (contain /) or URLs (start with http://, https://, doc://, etc.)
if '/' in obj or re.match(r'^[a-z]+://', obj):
return obj.replace(':', '-')
return obj
else:
return obj

# Rename all files and directories with colons
print("Step 1: Renaming files and directories with colons...")
rename_files_with_colons('./docs')
def build_rename_map(root_dir):
"""Collect files/directories with colons and build rename map."""
rename_map = {}
root_path = Path(root_dir)
for path in root_path.rglob("*"):
if ":" in path.name:
new_name = path.name.replace(":", "-")
new_path = path.with_name(new_name)
old_rel = path.relative_to(root_path).as_posix()
new_rel = new_path.relative_to(root_path).as_posix()
rename_map[old_rel] = new_rel
return rename_map

# Update JSON file references
print("\nStep 2: Updating JSON references...")
json_files = list(glob.glob('./docs/**/*.json', recursive=True))
print(f"Found {len(json_files)} JSON files to process")
def apply_renames(root_dir, rename_map):
"""Rename files/directories depth-first to avoid conflicts."""
root_path = Path(root_dir)
for old_rel in sorted(rename_map.keys(), key=lambda p: p.count("/"), reverse=True):
old_path = root_path / old_rel
new_path = root_path / rename_map[old_rel]
if old_path.exists():
print(f"Renaming: {old_path} -> {new_path}")
os.rename(old_path, new_path)

for json_file in json_files:
try:
with open(json_file, 'r', encoding='utf-8') as f:
data = json.load(f)
def build_replacements(rename_map):
replacements = []
for old_rel, new_rel in rename_map.items():
replacements.append((old_rel, new_rel))
replacements.append(("/" + old_rel, "/" + new_rel))
return replacements

def replace_all(content, replacements):
for old_value, new_value in replacements:
content = content.replace(old_value, new_value)
return content

# Fix paths in the JSON
fixed_data = fix_json_paths(data)
# Rename all files and directories with colons
print("Step 1: Building rename map for files/directories with colons...")
rename_map = build_rename_map('./docs')
print(f"Found {len(rename_map)} paths to rename")

# Write back
with open(json_file, 'w', encoding='utf-8') as f:
json.dump(fixed_data, f, ensure_ascii=False, separators=(',', ':'))
except Exception as e:
print(f"Error processing {json_file}: {e}")
print("\nStep 2: Renaming files and directories...")
apply_renames('./docs', rename_map)

# Also fix HTML files that might reference paths with colons
print("\nStep 3: Updating HTML references...")
html_files = list(glob.glob('./docs/**/*.html', recursive=True))
print(f"Found {len(html_files)} HTML files to process")
# Update JSON and HTML references to renamed paths
print("\nStep 3: Updating JSON and HTML references...")
files_to_update = []
files_to_update.extend(glob.glob('./docs/**/*.json', recursive=True))
files_to_update.extend(glob.glob('./docs/**/*.html', recursive=True))
print(f"Found {len(files_to_update)} files to process")

for html_file in html_files:
replacements = build_replacements(rename_map)
for path in files_to_update:
try:
with open(html_file, 'r', encoding='utf-8') as f:
with open(path, 'r', encoding='utf-8') as f:
content = f.read()

# Replace colons in paths/URLs within HTML
# Match href, src, or any attribute with a path
fixed_content = re.sub(r'(href|src|data-path|data-url)=["\']([^"\']*):([^"\']*)["\']',
r'\1="\2-\3"', content)

if fixed_content != content:
with open(html_file, 'w', encoding='utf-8') as f:
f.write(fixed_content)

updated = replace_all(content, replacements)
if updated != content:
with open(path, 'w', encoding='utf-8') as f:
f.write(updated)
except Exception as e:
print(f"Error processing {html_file}: {e}")
print(f"Error processing {path}: {e}")

# Verify no files with colons remain
print("\nStep 4: Verifying no files with colons remain...")
Expand Down Expand Up @@ -406,4 +379,4 @@ jobs:

id: deployment

uses: actions/deploy-pages@v4
uses: actions/deploy-pages@v4
62 changes: 53 additions & 9 deletions test-docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,60 @@ for target in AGUICore AGUIClient AGUITools AGUIAgentSDK; do
done

echo ""
echo "🔧 Fixing filenames (colons -> hyphens)..."
find ./docs-test -depth -name "*:*" | while read -r file; do
dir=$(dirname "$file")
base=$(basename "$file")
newbase=$(echo "$base" | tr ':' '-')
mv "$file" "$dir/$newbase"
done
echo "🔧 Fixing filenames (colons -> hyphens) and updating references..."
python3 - << 'PYTHON_EOF'
import os
import glob
from pathlib import Path

def build_rename_map(root_dir):
rename_map = {}
root_path = Path(root_dir)
for path in root_path.rglob("*"):
if ":" in path.name:
new_name = path.name.replace(":", "-")
new_path = path.with_name(new_name)
old_rel = path.relative_to(root_path).as_posix()
new_rel = new_path.relative_to(root_path).as_posix()
rename_map[old_rel] = new_rel
return rename_map

def apply_renames(root_dir, rename_map):
root_path = Path(root_dir)
for old_rel in sorted(rename_map.keys(), key=lambda p: p.count("/"), reverse=True):
old_path = root_path / old_rel
new_path = root_path / rename_map[old_rel]
if old_path.exists():
os.rename(old_path, new_path)

def build_replacements(rename_map):
replacements = []
for old_rel, new_rel in rename_map.items():
replacements.append((old_rel, new_rel))
replacements.append(("/" + old_rel, "/" + new_rel))
return replacements

def replace_all(content, replacements):
for old_value, new_value in replacements:
content = content.replace(old_value, new_value)
return content

rename_map = build_rename_map("./docs-test")
print(f"Found {len(rename_map)} paths to rename")
apply_renames("./docs-test", rename_map)

echo "🔧 Updating JSON references..."
find ./docs-test -name "*.json" -type f -exec sed -i '' 's/:/\\-/g' {} +
if rename_map:
replacements = build_replacements(rename_map)
files_to_update = glob.glob("./docs-test/**/*.json", recursive=True)
files_to_update.extend(glob.glob("./docs-test/**/*.html", recursive=True))
for path in files_to_update:
with open(path, "r", encoding="utf-8") as f:
content = f.read()
updated = replace_all(content, replacements)
if updated != content:
with open(path, "w", encoding="utf-8") as f:
f.write(updated)
PYTHON_EOF

echo ""
echo "📄 Creating landing page..."
Expand Down
Loading