Skip to content

Rebuild Slack app docs and promote to a top-level docs section#17085

Open
VojtechBartos wants to merge 17 commits into
masterfrom
vojtab/slack-app-docs
Open

Rebuild Slack app docs and promote to a top-level docs section#17085
VojtechBartos wants to merge 17 commits into
masterfrom
vojtab/slack-app-docs

Conversation

@VojtechBartos
Copy link
Copy Markdown
Member

@VojtechBartos VojtechBartos commented May 28, 2026

Summary

Full rebuild and reorganization of the Slack app docs. The previous single page at /docs/posthog-code/slack documented behavior that no longer exists (the removed default repo commands) and missed everything shipped in PostHog/posthog#60249 (per-user project routing in multi-integration Slack workspaces).

Content

  • Replaces the deprecated default repo set/show/clear commands with the actual supported set, including the new @PostHog project / project <id> commands from #60249 — listed in the same order the bot prints them with @PostHog help.
  • Documents the personal GitHub integration as mandatory for the coding agent (not a soft fallback) with the exact in-thread error the bot posts, plus a callout for the GitHub OAuth "Save button disabled" workaround.
  • Adds a Pick a project section explaining the new multi-integration workspace routing (thread → personal default → workspace default → sole candidate → picker).
  • Adds a Limitations section: ~6h sandbox lifetime, single-author follow-ups, text-only input, no DMs, 500-repo picker cap, workflow timeouts (10 min mention / 15 min picker).
  • Adds a Pricing page noting that agent activity bills through PostHog AI credits per the launch RFC (requests-for-comments-public#548), while subscriptions/unfurl/CDP destinations remain free.

Structure

  • Moves docs from /docs/posthog-code/slack to /docs/slack-app/, matching the marketing landing page URL and the convention used by other PostHog surfaces (/docs/vscode-extension/, /docs/cmd-k/, /docs/toolbar/). Redirect added in vercel.json.
  • Promotes the Slack app to a top-level docs menu entry alongside PostHog AI / PostHog Code, with an IconAtSign icon (no IconSlack ships in @posthog/icons).
  • Splits the doc into four pages: Overview, Setup, Commands, Pricing — each deep-linkable from the product page (PostHog Slack App Product Page #17077) and other docs.
  • Removes the duplicate Slack entry from Product OS → "Tools and features" so there's one source of truth for the nav.

Screenshots

Uploaded the Slack integration panel and the personal GitHub integration screenshots to Cloudinary; both render in the Setup page at 800px-normalized widths.

Test plan

  • Preview renders all four pages: /docs/slack-app, /docs/slack-app/setup, /docs/slack-app/commands, /docs/slack-app/pricing.
  • /docs/posthog-code/slack redirects to /docs/slack-app.
  • Top-level "Slack app" entry appears in the docs nav with the @ icon, between PostHog Code and Workflows.
  • All four nav children resolve (Overview, Setup, Commands, Pricing).
  • Internal links resolve: /code, /slack-app, /docs/libraries/slack#link-unfurling, /docs/cdp/destinations/slack, /docs/posthog-ai/pricing, /docs/slack-app/setup#pick-a-project-multi-integration-workspaces.
  • Both app.posthog.com setting deep-links open the right panel.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 28, 2026

Deploy preview

Status Details Updated (UTC)
🟢 Ready View preview May 29, 2026 11:19AM

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 28, 2026

Vale prose linter → found 34 errors, 12 warnings, 0 suggestions in your markdown

Full report → Copy the linter results into an LLM to batch-fix issues.

Linter being weird? Update the rules!

contents/docs/posthog-code/index.mdx — 0 errors, 3 warnings, 0 suggestions
Line Severity Message Rule
36:5 warning 'Worktree' is a possible misspelling. PostHogBase.Spelling
50:99 warning 'enricher' is a possible misspelling. PostHogBase.Spelling
92:116 warning 'repo's' is a possible misspelling. PostHogBase.Spelling
contents/docs/slack-app/commands.mdx — 2 errors, 1 warnings, 0 suggestions
Line Severity Message Rule
19:307 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
39:54 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
40:5 warning 'DMs' is a possible misspelling. PostHogBase.Spelling
contents/docs/slack-app/index.mdx — 14 errors, 3 warnings, 0 suggestions
Line Severity Message Rule
7:79 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
11:172 warning 'sandboxed' is a possible misspelling. PostHogBase.Spelling
11:331 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
19:96 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
29:109 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
29:113 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
29:128 warning Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. PostHogBase.ProductNames
41:133 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
49:100 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
66:197 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
70:33 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
71:39 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
72:37 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
73:43 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
74:24 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
75:56 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
76:71 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
contents/docs/slack-app/pricing.mdx — 6 errors, 0 warnings, 0 suggestions
Line Severity Message Rule
7:113 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
11:160 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
11:220 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
17:52 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
26:65 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
30:301 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
contents/docs/slack-app/setup.mdx — 12 errors, 5 warnings, 0 suggestions
Line Severity Message Rule
10:266 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
18:45 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
18:82 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
22:23 warning 'OAuth' is a possible misspelling. PostHogBase.Spelling
22:271 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
30:31 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
32:62 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
32:388 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
42:156 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
42:187 warning 'OAuth' is a possible misspelling. PostHogBase.Spelling
46:130 warning 'OAuth' is a possible misspelling. PostHogBase.Spelling
46:163 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
50:152 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
53:25 warning Use 'ID' instead of 'id'. Vale.Terms
54:22 warning Use 'ID' instead of 'id'. Vale.Terms
56:43 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash
67:91 error Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. PostHogBase.EnDash

@VojtechBartos VojtechBartos force-pushed the vojtab/slack-app-docs branch from de372ac to d5e7d2e Compare May 29, 2026 07:53
@VojtechBartos VojtechBartos changed the title Rebuild PostHog Code Slack app docs Rebuild Slack app docs and promote to a top-level docs section May 29, 2026
Comment thread contents/docs/slack-app/commands.mdx Outdated
- **Personal GitHub auth is per user.** Every teammate who wants to ship a PR has to connect their own GitHub once. First-time setup has known rough edges.
- **Single-author follow-ups.** Only the person who started a task can steer it. Colleagues' messages become context, not instructions.
- **Text input only.** The agent can't read images yet - paste descriptions instead of screenshots.
- **No DMs.** The bot doesn't respond in direct messages. Add it to a private channel of one if you want a quiet space.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This we can easily support via slack agents, it's just a couple of scope changes and we are there. We can maybe point to it coming soon?


| Emoji | What it means |
|---|---|
| 🌱 `:seedling:` | Saw your mention and is spinning up a new task |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

not sure if worth it but saw we shipped this PostHog/posthog#60469 so maybe we can already update that?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

reverted 😆 PostHog/posthog#60650

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

:D :D :D

Comment thread contents/docs/slack-app/index.mdx Outdated
| 🌱 `:seedling:` | Saw your mention and is spinning up a new task |
| 👀 `:eyes:` | Forwarding a follow-up to the running agent, or resuming a previous run |
| 🦔 `:hedgehog:` | The agent finished and posted its reply in the thread |
| ❌ `:x:` | Something went wrong – usually the sandbox stopped before the message could be delivered |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

let's remove the em-dash here, also that ❌ really is generic so maybe worth removing the "sandbox stopped" guess since we catch everything in there

Comment thread contents/docs/slack-app/setup.mdx Outdated
alt="The Slack integration section in project settings, with the Add to Slack button"
/>

To talk to the bot in a channel, invite it: `/invite @PostHog`. The first time it sees a mention, it matches your Slack email to your PostHog account, so make sure you're signed in to the same org on both sides.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

a first mention would also work right? (meaning, w/out explicit invite command


<CalloutBox icon="IconWarning" title="Reconnect if you installed before 2026-05-04" type="caution">

The bot picked up new OAuth scopes on 2026-05-04 (`app_mentions:read`, `users:read`, `users:read.email`, `chat:write`, `channels:history`, `groups:history`, `reactions:write`). If your workspace was connected before that date, head back to **Add to Slack** and re-approve - otherwise the bot will fail with a missing-scope error on the next mention.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

can we automate this/trigger re-auth?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

tbh haven't checked, going to investigate

@VojtechBartos VojtechBartos self-assigned this May 29, 2026
@VojtechBartos VojtechBartos marked this pull request as ready for review May 29, 2026 10:36
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