Skip to content

Draft Connectors concept doc#177

Open
vaurdan wants to merge 3 commits intomainfrom
connectors-concept-draft
Open

Draft Connectors concept doc#177
vaurdan wants to merge 3 commits intomainfrom
connectors-concept-draft

Conversation

@vaurdan
Copy link
Copy Markdown

@vaurdan vaurdan commented May 4, 2026

Summary

Adds a UI-led concept doc for Connectors at /concepts/connectors, the feature shipping on sprites.dev/api/connectors (in superfly/sprites-api PR #579).

Marked draft: true to match the existing /concepts/* convention from #65 (Kyle's "Unpublish all pages except Getting Started"). Not added to the sidebar — reachable via in-page links from elsewhere when ready.

What's in it

  • What a connector is and why (credential lives once in the org, Sprite never holds the token)
  • Providers table (Slack as User, Slack as Bot, GitHub, OpenRouter, Custom API)
  • Setting up a connector — dashboard walkthrough with screenshots of the connectors list and "Add connection" dropdown
  • Configuring access — screenshot of the connector detail page, explanation of name prefix / sprite labels / allow-all / authorized sprites preview
  • Calling a connector from a Sprite — gateway URL shape + example
  • Endpoint allow- and block-lists — pattern syntax + warning callout that block rules win
  • Managed providers — the new framing for things like managed OpenRouter that's billed as part of the Sprites plan, with a screenshot
  • Using connectors with a coding agent — the sprite-api-gateway skill pre-installed in every Sprite for Claude / Cursor / Codex / Gemini, with the natural-language UX
  • Common errors — the four most likely 401/403 paths
  • Automating with the API — collapsed at the bottom for power users

Screenshots

Four sanitized dashboard screenshots under public/images/connectors/:

  • list.png — main connectors page
  • add-menu.png — Add connection dropdown opened
  • detail.png — Slack connector detail (scopes, access policy editor, authorized sprites, API usage)
  • managed.png — Managed OpenRouter (managed-by-Sprites framing, usage strip, allow-all warning)

All real org / workspace / user / connector ID / API key values were replaced before capture. Dev-mode-only UI (Dev Tools tab, Gateway Playground card, Purge button) was stripped before screenshotting; the long sprite list on the managed connector was trimmed to four entries for readability.

Notes

  • Companion change in superfly/sprites-api#579 tightens the API-page intro on sprites.dev/api/connectors and links here.
  • Page is draft: true so it'll only be visible to authors with the draft toggle on.

UI-led walkthrough of the Connectors feature shipping on
sprites.dev/api/connectors. Covers what a connector is, providers,
setting one up via the dashboard, configuring the access policy,
calling a connector from a Sprite, endpoint allow/block lists, managed
providers (OpenRouter), and the sprite-api-gateway agent skill.

Includes four sanitized dashboard screenshots under
public/images/connectors/.

Marked draft: true to match the existing /concepts/* convention; not
added to the sidebar.
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 4, 2026

Preview Deployment

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

Commit: 65d6d34

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 4, 2026

E2E Test Results

✅ Tests success

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 4, 2026

Lighthouse Results

⚠️ Lighthouse failed to collect results. This may be due to the preview deployment not being ready.

@kcmartin kcmartin self-requested a review May 5, 2026 03:23
Copy link
Copy Markdown
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.

Thanks for opening this draft. Added several copy edit suggestions.

Comment thread src/content/docs/concepts/connectors.mdx
Comment thread src/content/docs/concepts/connectors.mdx Outdated
Comment thread src/content/docs/concepts/connectors.mdx Outdated
Comment thread src/content/docs/concepts/connectors.mdx Outdated
Comment thread src/content/docs/concepts/connectors.mdx Outdated
Comment thread src/content/docs/concepts/connectors.mdx Outdated
Comment thread src/content/docs/concepts/connectors.mdx Outdated
Comment thread src/content/docs/concepts/connectors.mdx Outdated
Comment thread src/content/docs/concepts/connectors.mdx Outdated
Comment thread src/content/docs/concepts/connectors.mdx Outdated
Drop unused Tabs/TabItem import and apply Kyle's copy edit suggestions
(em-dashes to commas/conjunctions, a few small phrasing tweaks).
@vaurdan
Copy link
Copy Markdown
Author

vaurdan commented May 6, 2026

Bloody em-dashes! Thank you for your feedback @kcmartin, I just addressed it.

@vaurdan vaurdan requested a review from kcmartin May 6, 2026 11:09
Copy link
Copy Markdown
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.

LGTM! Are we planning to keep this in "draft" status / not added to sidebar until the feature is GA, or ?

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