Skip to content

docs(TSP-1430): add Slack Forms documentation with dropdown field support - #801

Open
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1430
Open

claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1430

Conversation

@claude

@claude claude Bot commented Sep 1, 2026

Copy link
Copy Markdown

Summary

  • Creates new page integrations/popular-integrations/slack-forms.mdx documenting Slack Forms with text input and dropdown field types, wizard steps, and limitations
  • Updates integrations/popular-integrations/slack.mdx with a "Collecting structured input with Slack Forms" section and a new FAQ entry
  • Adds the new page to docs.json navigation under the Communication group, immediately after the Slack integration entry

Covers the changes from PR #17558, which added dropdown (single-choice select) field support and a 3,000-character limit to text inputs in Slack forms.

Linear issue: https://linear.app/relevance/issue/TSP-1430/

Test plan

  • New slack-forms.mdx page renders correctly in Mintlify preview
  • Navigation entry appears in sidebar under the Slack integration
  • Internal links from slack.mdx to /integrations/popular-integrations/slack-forms resolve correctly
  • All headings are in sentence case
  • No banned words used (powerful, seamlessly, effortlessly, etc.)

🤖 Generated with Claude Code

…port

Adds a dedicated Slack Forms page covering text input and dropdown field
types (including the new options array), wizard steps, and limitations.
Updates the Slack integration page with a summary section and FAQ entry
linking to the new page. Adds the page to docs.json navigation.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude claude Bot added the docs-drafter Documentation drafted by Claude label Sep 1, 2026
@mintlify

mintlify Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
relevanceai 🟢 Ready View Preview Sep 1, 2026, 4:37 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@linear

linear Bot commented Sep 1, 2026

Copy link
Copy Markdown

TSP-1430

@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 2 files (2 with issues, 0 clean) + docs.json navigation update

Scores

Dimension Score What's holding it back
🔴 Consistency 5/10 agent used in lowercase ~10 times in slack-forms.mdx and 3 times in slack.mdx when referring to the Relevance AI Agent product. Six headings in slack.mdx violate sentence case. One accordion title has "setup" as one word (should be "set up").
🟡 Technical clarity 7/10 slack-forms.mdx never explains where to configure a form in the UI — the JSON example floats without context about which builder screen it lives on. Grammar error: "Once setup" → "once set up" in a <Note>.
🟡 Non-technical clarity 7/10 slack-forms.mdx is missing a "how to create a form" setup section — a non-technical reader learns what forms are and how fields work, but gets no path to actually creating one.
🟡 Structure 7/10 <Tip> in slack.mdx contains a numbered list with bold labels, violating the single-paragraph callout rule. <CardGroup> in slack-forms.mdx has non-linking cards describing two field types — a table or prose would serve better here.

Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5.

Overall vibe: The new slack-forms.mdx page is logically structured and covers the right ground — field types, wizard flows, limitations, and troubleshooting — but it repeatedly lowercases "agent" when referring to the Relevance AI Agent product and skips the most important question a reader will have: how do I actually create a form in the UI? The slack.mdx additions are solid, but a cluster of heading-case violations and one malformed callout need fixing before ship.

🔧 Issues (18)

Product term capitalization — agent should be Agent throughout slack-forms.mdx:

  • integrations/popular-integrations/slack-forms.mdx:7 — "When an agent needs specific information" → "When an Agent needs specific information"
  • integrations/popular-integrations/slack-forms.mdx:15 — "when an agent triggers a form step" → "when an Agent triggers a form step"
  • integrations/popular-integrations/slack-forms.mdx:30 — "The agent receives the option's value" (Card body) → "The Agent receives the option's value"
  • integrations/popular-integrations/slack-forms.mdx:43 — "the agent receives when the user selects" → "the Agent receives"
  • integrations/popular-integrations/slack-forms.mdx:68 — "the agent receives the string "high"" → "the Agent receives"
  • integrations/popular-integrations/slack-forms.mdx:72 — "The agent always receives the option's value" → "The Agent always receives"
  • integrations/popular-integrations/slack-forms.mdx:81 — "The agent receives all values from all steps" → "The Agent receives"
  • integrations/popular-integrations/slack-forms.mdx:97 — "The agent receives the value field" → "The Agent receives"
  • integrations/popular-integrations/slack-forms.mdx:99 — "what the agent expects" → "what the Agent expects"

Product term capitalization — slack.mdx:

  • integrations/popular-integrations/slack.mdx:148 — "To escalate your agent to Slack" → "To escalate your Agent to Slack"
  • integrations/popular-integrations/slack.mdx:149 — "Select the agent you want to escalate" → "Select the Agent you want to escalate"
  • integrations/popular-integrations/slack.mdx:299 — FAQ accordion title: "Can my agent show a dropdown" → "Can my Agent show a dropdown"

Heading sentence case — slack.mdx:

  • integrations/popular-integrations/slack.mdx:105### Advanced Trigger Settings### Advanced trigger settings
  • integrations/popular-integrations/slack.mdx:107#### Live Status Updates#### Live status updates
  • integrations/popular-integrations/slack.mdx:111#### Exclude Keywords#### Exclude keywords
  • integrations/popular-integrations/slack.mdx:123#### No Agent Reply#### No Agent reply (Agent stays capped as product term; Reply is not)
  • integrations/popular-integrations/slack.mdx:136### Customize Message Formatting### Customize message formatting
  • integrations/popular-integrations/slack.mdx:161## Agent Notifications## Agent notifications

Grammar:

  • integrations/popular-integrations/slack.mdx:102 — "Once setup, you can trigger your Agent" → "Once set up, you can trigger your Agent" (set up is two words as a verb)
  • integrations/popular-integrations/slack.mdx:263 — Accordion title: "When I setup a Slack trigger" → "When I set up a Slack trigger"
🧩 Component suggestions (3)
  • integrations/popular-integrations/slack.mdx:77–82<Tip> contains a numbered list with bold labels (**Channel vs DM setup:**, **For channels:**, **For your DM:**). CLAUDE.md requires callouts to be a single short paragraph with no lists and no bold labels. Either convert to prose ("For a channel, use /invite @Relevance AI; for your own DM, send any message to the Relevance AI bot.") or remove the <Tip> wrapper and make this a brief prose paragraph under its own sub-heading.

  • integrations/popular-integrations/slack-forms.mdx:25–32<CardGroup cols={2}> with two non-linking cards ("Text input" and "Dropdown") that just describe field properties. Per CLAUDE.md, cards without links are appropriate only for feature lists with real substance per card. Here the same information is immediately restated in the ### Text input and ### Dropdown sections below. Replace the CardGroup with a two-column markdown table (Field type | Description | Limit) or simply remove it and let the subheadings do the work.

  • integrations/popular-integrations/slack.mdx:113–119 and 127–130 — The **To configure:** / **To enable:** bold labels followed by numbered lists are acting as informal sub-sub-headings. Use <Steps> components here so the visual progress indicator matches the procedural intent. Example: <Steps><Step title="Open your Slack trigger settings">Expand **Advanced Settings**.</Step>…</Steps>.

🏗️ Page structure (1)
  • integrations/popular-integrations/slack-forms.mdx — The page explains what forms are and how fields work, but never explains how to create a form in Relevance AI. The JSON example in the dropdown accordion shows what a field definition looks like, but there's no indication of which UI screen this appears on, how to add a form step to an agent, or what the starting point is for a user who just landed on this page. Add a short "Creating a form" section (or a numbered setup flow) between the intro and "Field types" so readers can follow end-to-end. This is the highest-impact structural gap.
⚠️ Contradictions (0)

No contradictions found between the changed files and context pages read.

🔋 Credit usage
Item Count
Files reviewed 2 MDX + docs.json
Context pages read 0 (both linked files were already in the changed set)
Total lines processed ~1,571

Files read: integrations/popular-integrations/slack-forms.mdx (104 lines), integrations/popular-integrations/slack.mdx (328 lines), docs.json (1,139 lines, navigation section skimmed)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-drafter Documentation drafted by Claude

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant