Skip to content

Conversation

@kcmartin
Copy link
Collaborator

@kcmartin kcmartin commented Jan 21, 2026

Summary

  • Fixed broken card links on the API reference index page (e.g., /api/v001-rc30/)
  • The card href attributes were using the full version ID (v0.0.1-rc30) but Astro routes use the slugified version (v001-rc30)
  • Now uses versionToSlug() to generate correct URLs

Root cause

The generateIndexPage function in scripts/generate-api-docs.ts was generating LinkCard hrefs like /api/v0.0.1-rc30/sprites, but Astro removes dots from directory names when creating routes, so the actual URL is /api/v001-rc30/sprites.

Test plan

  • Run pnpm build to regenerate API docs
  • Verify card links on /api/v001-rc30/ point to correct slugified URLs
  • Click through cards to confirm they resolve correctly

🤖 Generated with Claude Code

The API index page card links were using the full version ID (e.g.,
v0.0.1-rc30) but Astro routes use the slugified version (v001-rc30).
This caused all card links on the API reference page to 404.

Co-Authored-By: Claude Opus 4.5 <[email protected]>
@github-actions
Copy link
Contributor

github-actions bot commented Jan 21, 2026

CLI Documentation Generator

Metric Value
CLI Version 0.0.1
Commands Generated 24
Tests ✅ 0/0 passed
📚 Commands documented
  • sprite login
  • sprite logout
  • sprite org auth
  • sprite org list
  • sprite org logout
  • sprite org keyring disable
  • sprite org keyring enable
  • sprite auth setup
  • sprite create
  • sprite use
  • sprite list
  • sprite destroy
  • sprite exec
  • sprite console
  • sprite checkpoint create
  • sprite checkpoint list
  • sprite checkpoint info
  • sprite checkpoint delete
  • sprite restore
  • sprite proxy
  • sprite url
  • sprite url update
  • sprite api
  • sprite upgrade

The Python SDK card linked to /sdks/python which doesn't exist yet.

Co-Authored-By: Claude Opus 4.5 <[email protected]>
@github-actions
Copy link
Contributor

github-actions bot commented Jan 21, 2026

Preview Deployment

Name URL
Preview https://pr-100-superfly-sprites-docs.fly.dev

Commit: 8275e78

@github-actions
Copy link
Contributor

github-actions bot commented Jan 21, 2026

Lighthouse Results

URL Performance Accessibility Best Practices SEO
/ 🟢 91 🟢 100 🟢 96 🟢 100

@github-actions
Copy link
Contributor

github-actions bot commented Jan 21, 2026

E2E Test Results

✅ Tests success

Ran against: https://pr-100-superfly-sprites-docs.fly.dev

The SDK pages at /sdks/* are not accessible on the live site,
causing all SDK card links to 404.

Co-Authored-By: Claude Opus 4.5 <[email protected]>
@kcmartin kcmartin merged commit 8e86ee9 into main Jan 21, 2026
5 checks passed
@kcmartin kcmartin deleted the fix/api-card-link-version-slugs branch January 21, 2026 21:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants