Skip to content

Remove Slack provider from connectors docs (matches ui-ex#5017)#219

Open
kcmartin wants to merge 2 commits into
mainfrom
remove-slack-provider
Open

Remove Slack provider from connectors docs (matches ui-ex#5017)#219
kcmartin wants to merge 2 commits into
mainfrom
remove-slack-provider

Conversation

@kcmartin

@kcmartin kcmartin commented Jul 22, 2026

Copy link
Copy Markdown
Collaborator

Two related cleanups to the connectors page (src/content/docs/concepts/connectors.mdx), no other page touched.

1. Remove Slack as a documented provider

The dashboard is hiding the Slack connector provider until superfly/ui-ex#5017 (private) is fixed — Slack connectors currently only work for the Fly workspace. This makes the docs match that state. Per jae, GitHub becomes the permanent running example; when the bug lands, only the two provider-table rows come back (tracked in #220).

  • Removed the Slack as User / Slack as Bot provider-table rows.
  • Every Slack example → GitHub: gateway curl (POST /v1/gateway/github/<conn>/repos/acme/website/issues), OAuth authorize (/v1/oauth/github/authorize?scopes=repo,read:org), endpoint patterns (/repos/...), update-policy labels (["github"]), and the agent-task example (GitHub PR comment).
  • Dropped Slack from the intro, the setup bullet, and the coding-agent prose.
  • Common errors unchanged (all provider-generic).

Gateway slug github confirmed against the API reference (provider enum: "slack" | "slack_bot" | "github" | "openrouter" | "custom_api").

2. Drop the dashboard screenshots in favor of prose

The four connector screenshots (list, add-menu, detail, managed) were confirmatory, not load-bearing — each sat directly below prose that already described it. They were also dark-only (docs default to light), stale-prone, and Slack-contaminated pending ui-ex#5017 (which would otherwise have needed a screenshot-retaking follow-up).

  • Removed all four ![...] embeds and deleted the now-unreferenced PNG assets under public/images/connectors/.
  • Stitched the one sentence that introduced the add-connection screenshot so the prose reads continuously. No factual content lost.

This removes the earlier "screenshots need retaking after ui-ex#5017" follow-up entirely.

Verification

  • pnpm build and pnpm lint clean. The built page contains zero slack and no image references. Whole-repo slack grep: all hits were on this page (no out-of-page references).

Merge when ui-ex#5017 deploys, not before (the Slack-removal half must match the dashboard; the screenshot cleanup is independent but folded into this PR).

The dashboard is hiding the Slack connector provider until the non-Fly-
workspace bug (superfly/ui-ex#5017) is fixed, so the docs should stop
documenting Slack as a provider. Per jae, GitHub becomes the permanent
running example throughout the connectors page; only the two provider-
table rows get restored when the bug lands.

- Drop the 'Slack as User' and 'Slack as Bot' rows from the provider table
- Remove Slack from the OAuth setup bullet (GitHub remains)
- Switch the gateway curl example to a GitHub repo-issues POST
- Switch the OAuth authorize example to GitHub scopes (repo, read:org)
- Reword the access-policy prose and endpoint patterns to GitHub
- Replace the Slack agent-task example with a GitHub PR comment
- Drop Slack from intro and coding-agent prose
@kcmartin

Copy link
Copy Markdown
Collaborator Author

Companion restore issue: #220 (restore the two provider-table rows when ui-ex#5017 lands; examples stay GitHub).

@github-actions

github-actions Bot commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Preview Deployment

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

Commit: 97f7642

@github-actions

github-actions Bot commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Lighthouse Results

URL Performance Accessibility Best Practices SEO
/ 🟢 93 🟢 100 🟢 96 🟢 100
/concepts/connectors/ 🟢 99 🟢 100 🟢 100 🟢 100

@github-actions

Copy link
Copy Markdown
Contributor

E2E Test Results

✅ Tests success

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

@kcmartin

Copy link
Copy Markdown
Collaborator Author

Slug confirmed: the public API reference (sprites.dev/api/connectors) defines the Connection provider enum as "slack" | "slack_bot" | "github" | "openrouter" | "custom_api". github is correct for both the gateway and OAuth paths — NEEDS-HUMAN slug flag cleared.

@kcmartin
kcmartin marked this pull request as ready for review July 22, 2026 23:23
@kcmartin
kcmartin requested a review from jbellerb July 22, 2026 23:23
@kcmartin

kcmartin commented Jul 22, 2026

Copy link
Copy Markdown
Collaborator Author

@jbellerb here's the companion PR for your UI change. https://github.com/superfly/ui-ex/pull/5017

The four connector screenshots were confirmatory, not load-bearing: each
sat directly below prose that already described it. They were also dark-
only (the docs default to light), stale-prone, and Slack-contaminated
pending ui-ex#5017, which would have meant a screenshot-retaking follow-up.

Remove all four images and the now-unreferenced PNG assets, and stitch the
one sentence that introduced the add-connection screenshot so it reads as
continuous prose. No factual content is lost.
@kcmartin

Copy link
Copy Markdown
Collaborator Author

Added a second commit: dropped all four dashboard screenshots (list / add-menu / detail / managed) in favor of the prose that already described them, and deleted the now-unreferenced PNGs. This removes the screenshot-retaking follow-up — issue #220 is now just the two provider-table rows.

@jbellerb

Copy link
Copy Markdown
Contributor

That's fine! The screenshots needed updating anyways since they're of the old dashboard. The text is clear enough without them.

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