Skip to content

Hide API Reference from sidebar#142

Merged
kylemclaren merged 1 commit intomainfrom
hide-api-docs-sidebar
Feb 10, 2026
Merged

Hide API Reference from sidebar#142
kylemclaren merged 1 commit intomainfrom
hide-api-docs-sidebar

Conversation

@kylemclaren
Copy link
Collaborator

Summary

  • Removes the API Reference section from the sidebar navigation
  • API docs pages remain accessible via direct URL, just hidden from the sidebar

Test plan

  • Verify the sidebar no longer shows the "API Reference" section
  • Verify API doc pages are still accessible via direct URL

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@github-actions
Copy link
Contributor

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

@github-actions
Copy link
Contributor

Preview Deployment

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

Commit: 4a15cff

@github-actions
Copy link
Contributor

Lighthouse Results

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

@github-actions
Copy link
Contributor

E2E Test Results

✅ Tests success

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

@kylemclaren kylemclaren requested a review from kcmartin February 10, 2026 20:15
Copy link
Collaborator

@kcmartin kcmartin left a comment

Choose a reason for hiding this comment

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

Do we want to link to the "other" official API docs in the sidebar ?

@kylemclaren kylemclaren merged commit e96fc73 into main Feb 10, 2026
5 checks passed
@kylemclaren kylemclaren deleted the hide-api-docs-sidebar branch February 10, 2026 23:08
@Taytay
Copy link

Taytay commented Feb 11, 2026

This confused the heck out of me, because I was writing a dashboard yesterday, and using these API docs as reference, and today they were gone. I felt crazy until I checked here. :)
Could you take a moment to clarify why they are hidden? Is it because we aren't supposed to use the "behind the scenes" API?

@kcmartin
Copy link
Collaborator

@Taytay We're consolidating, since there were two versions--you can use this API reference on the main sprites.dev site:
https://sprites.dev/api

Thanks for your patience as we develop more comprehensive docs for Sprites!

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.

3 participants