Skip to content

docs: improve Slack interface documentation#587

Merged
Mustafa-Esoofally merged 6 commits into
mainfrom
docs/slack-interface-improvements
Apr 3, 2026
Merged

docs: improve Slack interface documentation#587
Mustafa-Esoofally merged 6 commits into
mainfrom
docs/slack-interface-improvements

Conversation

@uzaxirr
Copy link
Copy Markdown
Contributor

@uzaxirr uzaxirr commented Mar 26, 2026

Summary

Complete rewrite of the Slack interface documentation. The previous version read like a technical spec. This version reads like docs.

What changed

Introduction page (rewritten from scratch)

  • One-line intro matching Stripe/Anthropic pattern ("The Slack interface lets you deploy agents, teams, or workflows as interactive Slack bots.")
  • Code-first with Agent/Team/Workflow tabs
  • Removed 44 rows of parameter tables from the guide page
  • Removed spec language ("the interface exposes", "namespaced by entity", "HMAC-SHA256 signatures")
  • Replaced with user-facing language ("the bot", "your agent", "conversations reset")
  • Zero em dashes (style guide compliance)
  • Sections: Setup, Example Usage, Sessions, Threads, Files, SlackTools, Multi-Instance, User Identity, Security, Troubleshooting (8 accordions), Developer Resources (4 cards)

New reference page (reference.mdx)

  • Interface parameters (17 rows), endpoints, event handling
  • Follows the same split pattern as deploy/templates/docker (overview + reference)

Deploy guide (rewritten)

  • Fixed wrong OAuth scopes (old: app_mention which isn't a scope; new: app_mentions:read)
  • Added "Agents & AI Apps" as Step 2 (most commonly missed setup step)
  • Added comprehensive scope-to-feature reference (minimum, file handling, SlackTools methods, events)
  • Scope tables map each OAuth scope to the specific feature/method that needs it

Usage pages (9 fixed + 5 new)

  • Fixed research-workflow.mdx: had completely fabricated code (gpt-5.2, HackerNewsTools, PostgreSQL). Replaced with actual cookbook content
  • Fixed agent-with-user-memory.mdx: wrong tools (HackerNewsToolsWebSearchTools), wrong model ID
  • Fixed reasoning-agent.mdx: wrong tools (YFinanceToolsWebSearchTools), wrong import path
  • Fixed model IDs across all pages to match cookbook source files
  • Created 5 new pages: file-analyst, multi-bot, multimodal-team, multimodal-workflow, research-assistant

SlackTools reference (updated)

  • Method signatures with parameters (e.g., upload_file(channel, content, filename, title?, initial_comment?, thread_ts?))
  • search:read scope note on enable_search_messages
  • Search modifiers tip
  • CardGroup for developer resources

Navigation (docs.json)

  • Slack interface: introduction + reference subgroup
  • 14 usage examples (was 9)

Type of change

  • Content improvement
  • Bug fix (wrong OAuth scopes, fabricated code examples, wrong model IDs)
  • New content (reference.mdx, 5 usage pages)

Checklist

  • Content is accurate and up-to-date
  • Code examples match cookbook source files
  • Zero em dashes (style guide rule 5)
  • No spec language ("the interface", "mounted", "namespaced")
  • All links tested
  • docs.json navigation updated

Copilot AI review requested due to automatic review settings March 26, 2026 17:26
@mintlify
Copy link
Copy Markdown

mintlify Bot commented Mar 26, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
agno 🟢 Ready View Preview Mar 26, 2026, 5:29 PM

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR refreshes the Slack documentation across the AgentOS interface docs, deploy guide, and usage examples, expanding coverage of Slack interface behavior and the SlackTools toolkit while adding new Slack usage pages and updating navigation.

Changes:

  • Expanded agent-os/interfaces/slack/introduction.mdx with detailed parameters/behavior (streaming, sessions, files/media) and an updated SlackTools reference section.
  • Added multiple new Slack usage pages (streaming research, support team, workflow, multiple instances, channel summarizer) and updated existing Slack usage snippets/imports.
  • Updated Slack docs navigation in docs.json and refreshed the Slack deploy guide content.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
tools/toolkits/social/slack.mdx Updates SlackTools overview, install instructions, and expands params/methods tables.
docs.json Adds the new Slack usage pages to navigation.
deploy/interfaces/slack/overview.mdx Cleans up Slack deploy guide; updates AgentOS import path; adjusts env var + ngrok instructions.
agent-os/interfaces/slack/introduction.mdx Major rewrite: adds parameters, endpoints, behavior sections, SlackTools reference, troubleshooting table.
agent-os/usage/interfaces/slack/basic.mdx Updates snippet filename/imports/model and usage instructions.
agent-os/usage/interfaces/slack/agent-with-user-memory.mdx Updates snippet filename and improves wording/formatting in the example.
agent-os/usage/interfaces/slack/reasoning-agent.mdx Updates snippet filename/imports/model and refines key-features section.
agent-os/usage/interfaces/slack/research-workflow.mdx Updates AgentOS import path, env var formatting, and adds key-features section.
agent-os/usage/interfaces/slack/streaming.mdx New page: streaming deep research example with task cards and suggested prompts.
agent-os/usage/interfaces/slack/support-team.mdx New page: multi-agent support team example using SlackTools + web search.
agent-os/usage/interfaces/slack/channel-summarizer.mdx New page: SlackTools-powered channel summarization example.
agent-os/usage/interfaces/slack/workflow.mdx New page: two-step workflow example using WebSearchTools + SQLite sessions.
agent-os/usage/interfaces/slack/multiple-instances.mdx New page: multiple Slack bots on one AgentOS with prefix-based routing.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread agent-os/interfaces/slack/introduction.mdx Outdated
Comment thread agent-os/usage/interfaces/slack/reasoning-agent.mdx Outdated
Comment thread tools/toolkits/social/slack.mdx Outdated
Comment thread deploy/interfaces/slack/overview.mdx Outdated
Comment thread deploy/interfaces/slack/overview.mdx
Comment thread agent-os/usage/interfaces/slack/streaming.mdx
Comment thread agent-os/usage/interfaces/slack/agent-with-user-memory.mdx Outdated
uzaxirr and others added 3 commits April 1, 2026 14:13
- Rewrite introduction.mdx with all 16 interface params, Behavior
  section (session management, streaming, file/media support),
  SlackTools section (17 params, 10 methods), troubleshooting table
- Update SlackTools reference page with complete params and methods
- Fix import paths to use `from agno.os.app import AgentOS`
- Fix code block titles and run commands to use short filenames
- Fix deploy guide: remove fluff, use uv pip, add session scope example
- Add 5 new usage pages: streaming, support-team, channel-summarizer,
  workflow, multiple-instances
- Update docs.json navigation with new pages
…agno[slack] install

- Fix reasoning-agent: ThinkingTools→ReasoningTools (module was renamed)
- Fix reasoning-agent: stock_price→enable_stock_price (correct param names)
- Use "agno[slack]" extras in all install commands (slack-sdk is required
  by the interface, not just SlackTools)
- Add lxml_html_clean to streaming deps (required by newspaper4k)
Rewrite introduction.mdx as a user-facing guide (not a spec sheet).
Split reference content into a separate reference.mdx page.
Rewrite deploy guide with correct OAuth scopes and comprehensive
scope-to-feature mapping. Fix 9 existing usage pages (wrong model IDs,
wrong imports, fabricated code). Create 5 new usage pages for cookbooks
that had no documentation. Update SlackTools reference with method
signatures and scope notes.
The latest mintlify CLI depends on keytar which requires
libsecret. Without it the broken-links check fails with
ERR_DLOPEN_FAILED on ubuntu-latest runners.
kausmeows
kausmeows previously approved these changes Apr 3, 2026
Comment thread agent-os/interfaces/slack/introduction.mdx Outdated
Comment thread agent-os/interfaces/slack/introduction.mdx Outdated
Comment thread deploy/interfaces/slack/overview.mdx Outdated
Comment thread deploy/interfaces/slack/overview.mdx Outdated
Comment thread agent-os/interfaces/slack/reference.mdx Outdated
Comment thread agent-os/interfaces/slack/reference.mdx Outdated
Comment thread agent-os/usage/interfaces/slack/research-workflow.mdx Outdated
Comment thread agent-os/interfaces/slack/reference.mdx
Comment thread tools/toolkits/social/slack.mdx Outdated
Comment thread agent-os/interfaces/slack/introduction.mdx Outdated
Comment thread agent-os/interfaces/slack/reference.mdx
Comment thread deploy/interfaces/slack/overview.mdx
Comment thread deploy/interfaces/slack/overview.mdx Outdated
Comment thread deploy/interfaces/slack/overview.mdx
Comment thread agent-os/interfaces/slack/introduction.mdx
Comment thread agent-os/usage/interfaces/slack/reasoning-agent.mdx
Comment thread agent-os/usage/interfaces/slack/workflow.mdx
Comment thread agent-os/usage/interfaces/slack/channel-summarizer.mdx
Comment thread agent-os/interfaces/slack/introduction.mdx
- Remove quotes from frontmatter titles/descriptions across all pages
- Replace DuckDuckGoTools with WebSearchTools in introduction examples
- Add search_messages user token warning
- Add search_workspace and get_channel_info to SlackTools reference (12 methods)
- Add HTTP 500 to reference status table
- Add channels:read to minimum OAuth scope (used by resolve_channel_name)
- Add groups:read, search_workspace scopes to SlackTools scope table
- Add SqliteDb to deploy guide example
- Update MemoryManager model to OpenAIChat(gpt-4o-mini)
- Add history params to reasoning-agent and workflow examples
- Add channel_id context instructions to channel-summarizer
- Remove duplicate research-workflow page (no cookbook exists)
- Fix troubleshooting self-loop cause wording
@Mustafa-Esoofally Mustafa-Esoofally merged commit 2eca396 into main Apr 3, 2026
4 checks passed
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.

5 participants