Skip to content

chore(seo): add canonical URL and OG metadata #2

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
ASGCompute merged 1 commit into from
Feb 1, 2026
Merged

chore(seo): add canonical URL and OG metadata #2

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
7 changes: 7 additions & 0 deletions mint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,13 @@
"mode": "hide"
}
},
"seo": {
"indexHiddenPages": true
},
"metadata": {
"og:site_name": "ASG Agent Cloud Documentation",
"og:image": "https://docs.asgcompute.com/images/og-image.png"
Comment on lines +56 to +58
Copy link

@coderabbitai coderabbitai bot Feb 1, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash

# Check if the URL is accessible and get status code
echo "Checking URL accessibility:"
curl -s -o /dev/null -w "HTTP Status: %{http_code}\n" "https://docs.asgcompute.com/images/og-image.png"

# Try to get image headers and basic info
echo -e "\nFetching image headers:"
curl -s -I "https://docs.asgcompute.com/images/og-image.png"

# If accessible, try to get image dimensions
echo -e "\nAttempting to retrieve and analyze image:"
curl -s "https://docs.asgcompute.com/images/og-image.png" -o /tmp/og-image.png 2>&1
if [ -f /tmp/og-image.png ] && [ -s /tmp/og-image.png ]; then
    file /tmp/og-image.png
    pip install pillow -q 2>/dev/null
    python3 << 'EOF'
from PIL import Image
import os

try:
    img = Image.open('/tmp/og-image.png')
    print(f"Image dimensions: {img.width}x{img.height} pixels")
    print(f"Image format: {img.format}")
    print(f"File size: {os.path.getsize('/tmp/og-image.png')} bytes")
except Exception as e:
    print(f"Error analyzing image: {e}")
EOF
else
    echo "Failed to retrieve image or image is empty"
fi

Repository: ASGCompute/asg-docs-public

Length of output: 1028

🌐 Web query:

Open Graph image sizing requirements recommendations best practices

💡 Result:

Recommended “works almost everywhere” OG image

  • 1200 × 630 px (aspect ratio 1.91:1) (ogpreview.app)
  • Use an image that’s publicly accessible and served over HTTPS (absolute URL). (ogpreview.app)

Platform-specific notes (common ones)

  • Facebook / Meta link preview
    • Recommended: 1200 × 630
    • Minimum accepted: 200 × 200
    • Max file size: 8 MB (ogpreview.app)
  • LinkedIn
    • Minimum: 1200 (w) × 627 (h), ratio 1.91:1
    • Max file size: 5 MB (linkedin.com)
  • X (Twitter) Cards (often uses twitter:* tags; may fall back to OG)
    • Images must be < 5 MB; JPG/PNG/WEBP/GIF supported; SVG not supported. (developer.x.com)
    • For summary_large_image, X documents a 2:1 image ratio (min 300×157). (developer.x.com)

Best-practice tags to include (helps rendering + accessibility)

  • Add dimensions: og:image:width and og:image:height (ogp.me)
  • Add alt text: og:image:alt (ogp.me)
  • Use og:image:secure_url when possible (ogp.me)
<meta property="og:image" content="https://example.com/og/your-page.jpg" />
<meta property="og:image:width" content="1200" />
<meta property="og:image:height" content="630" />
<meta property="og:image:alt" content="Brief description of the image" />

Citations:

Fix missing OG image asset—currently returns 404.

The URL https://docs.asgcompute.com/images/og-image.png returns HTTP 404, which breaks social media previews. Deploy the missing image or update the URL to a working asset. Best practice is 1200 × 630 px; also consider adding og:image:width, og:image:height, and og:image:alt attributes for better preview support.

🤖 Prompt for AI Agents 
In `@mint.json` around lines 56 - 58, The og:image URL in the metadata (the
"metadata" object, key "og:image") points to a 404 asset; either deploy the
missing file to https://docs.asgcompute.com/images/og-image.png or update the
"og:image" value to a reachable image (recommended 1200×630 px), and add
companion metadata keys "og:image:width", "og:image:height", and "og:image:alt"
inside the same metadata object to improve social preview rendering.

},
"navigation": [
{
"group": "Getting Started",
Expand Down