Skip to content

Add hosted API docs link#212

Merged
dcrawbuck merged 1 commit into
mainfrom
dcrawbuck/api
Jun 10, 2026
Merged

Add hosted API docs link#212
dcrawbuck merged 1 commit into
mainfrom
dcrawbuck/api

Conversation

@dcrawbuck

@dcrawbuck dcrawbuck commented Jun 10, 2026

Copy link
Copy Markdown
Collaborator

Adds a hosted API docs entry to the docs overview and shared layout tabs.
The tab is labeled API, opens https://api.superwall.com/docs externally, and is available in the compact mobile/iPad tab dropdown because it is now part of the shared DocsLayout tab list.
Internal overview cards still use router links, while external cards render as safe anchors with noopener/noreferrer.
Validated with bun run build:cf, bun test, and autoreview.


Note

Low Risk
Navigation and presentation only; no auth, data, or API behavior changes.

Overview
Adds a discoverable link to the hosted API reference at https://api.superwall.com/docs from the docs home and from every docs page navbar.

On doc pages, tab building moves out of sidebar.tabs into getDocsLayoutTabs, which uses fumadocs getLayoutTabs with the same SDK-aware URL and icon behavior as before, then appends an API tab (Code icon) that opens externally with target="_blank" and rel="noreferrer noopener". Those tabs are passed to DocsLayout via the top-level tabs prop so the API entry shows in the shared navbar / compact tab UI.

On the docs overview, a new API card sits with the other documentation sections. OverviewCard now treats absolute URLs as external and renders a plain anchor instead of a router Link, while internal paths still use client navigation.

Reviewed by Cursor Bugbot for commit 2d0c36b. Bugbot is set up for automated code reviews on this repo. Configure here.

@dcrawbuck dcrawbuck marked this pull request as ready for review June 10, 2026 22:24
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
superwall-docs-staging 2d0c36b Commit Preview URL

Branch Preview URL
Jun 10 2026, 10:29 PM

@dcrawbuck dcrawbuck merged commit ebdc461 into main Jun 10, 2026
3 checks passed
@dcrawbuck dcrawbuck deleted the dcrawbuck/api branch June 10, 2026 22:46
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.

1 participant