Skip to content

docs: Add inline integration management drawer documentation for Invent (TSP-1449) - #818

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

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

Conversation

@claude

@claude claude Bot commented Sep 15, 2026

Copy link
Copy Markdown

Summary

  • Adds a Connected accounts accordion to the Set up and use Invent section of build/invent/invent.mdx, explaining that users can manage integrations directly from the Invent chat via the inline drawer (add, rename, reconnect, remove accounts) without navigating away.
  • Adds a brief cross-reference <Tip> in integrations/add-integrations.mdx pointing Invent users to the new section.

References

Test plan

  • Verify the Connected accounts accordion renders correctly in the Invent features section
  • Verify the cross-reference Tip in add-integrations.mdx links to the correct anchor
  • Check sentence case on all new headings and titles
  • Confirm no bullet lists inside accordion content (flowing sentences used)

🤖 Generated with Claude Code

Add Connected accounts accordion to the Invent Set up and use section,
explaining the inline drawer for adding, renaming, reconnecting, and
removing integrations without leaving the chat. Add a cross-reference
Tip in add-integrations.mdx pointing to the new section.

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

mintlify Bot commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
relevanceai 🟢 Ready View Preview Sep 15, 2026, 3:05 AM

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

@linear

linear Bot commented Sep 15, 2026

Copy link
Copy Markdown

TSP-1449

@github-actions

Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 2 files (2 with issues, 0 clean)

Scores

Dimension Score What's holding it back
🟡 Consistency 7/10 Banned word "powerful" in add-integrations.mdx description; heading case error "Setting Up Integrations"; missing bold on UI element names in trigger steps; accordion title "About you" doesn't match the product UI name "About You" used in body text.
🟡 Technical clarity 7/10 Trigger setup steps in add-integrations.mdx don't bold UI element names, making them harder to scan; "Configure an alarm" tab in invent.mdx describes auto-diagnosis before giving any steps to set up the alarm itself.
🟡 Non-technical clarity 7/10 add-integrations.mdx opens with marketing framing ("powerful workflow automation tools") and has a Popular Integrations section that lists generic capabilities rather than actionable guidance.
🟡 Structure 7/10 invent.mdx has significant intra-page duplication — the Availability blurb and all three Enterprise security accordions are copied verbatim into the FAQ. add-integrations.mdx uses plain numbered lists instead of <Steps> for procedures and has no closing CTA.

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

Overall vibe: The Invent page is comprehensive and well-organized — access controls, feature detail, Evals integration, and the MCP comparison are all solid. The main drag is the FAQ section duplicating earlier content word-for-word rather than referencing it. The add-integrations page needs more work: a banned word in its description, a heading case error, thin content in Popular Integrations, and no closing CTA leave it feeling undercooked.

🔧 Issues (5)
  • integrations/add-integrations.mdx:3 — "powerful" is a banned word. Description reads "transform your AI agents into powerful workflow automation tools" — rewrite as "connect your Agents to external services so they can read data and take actions in those platforms" or similar.
  • integrations/add-integrations.mdx:11 — heading "Setting Up Integrations" → sentence case: "Setting up integrations"
  • integrations/add-integrations.mdx:28–33 — Trigger setup steps reference UI elements by name but don't bold them. introduction.mdx (the sibling) bolds these same references consistently. Fix: "Select Agent Profile from the menu", "Locate the Triggers section", click Add Trigger".
  • build/invent/invent.mdx:126 — Accordion title="About you" (lowercase y). The body text at lines 129 and 140 references this feature as About You (proper UI name, bolded). Title should match: title="About You".
  • build/invent/invent.mdx:44–46, 92–102, 340–353 — The Availability paragraph (line 46) and all three Enterprise security control accordions (Project isolation, Integration reach, Data egress, lines 92–101) are reproduced verbatim in the FAQ (lines 340–353). This quadruples the word count for the same information with no added value. Keep one canonical location and link to it from the other. The AccordionGroup is the better home for the detail; the FAQ items should either be removed or replaced with a single "See the Enterprise security controls section above."
🧩 Component suggestions (2)
  • integrations/add-integrations.mdx:25–33 — "Adding Triggers to Agents" is a sequential six-step procedure but uses a plain numbered list. Per CLAUDE.md, <Steps> is appropriate here. Each step title should name the action ("Navigate to Agent Settings", "Open Agent Profile", "Add a trigger") and each step body should have the detail. This also gives space to properly bold UI element names inside each step.
  • integrations/add-integrations.mdx:13–19 — The "Setting up integrations" steps also use a plain numbered list and describe a sequential procedure. Same fix applies — wrap in <Steps>. Notably, invent.mdx consistently uses <Steps> for multi-step procedures; matching that pattern across the integrations section would make the docs feel coherent.
🏗️ Page structure (2)
  • integrations/add-integrations.mdx — page ends after the HubSpot integration bullet list with no closing CTA. As a how-to page, a "What's next?" section would help readers continue. Good candidates: /integrations/introduction (more detail on triggers and actions), /integrations/remove-integrations (complement to adding), or a specific integration example page from /integrations/popular-integrations/.
  • integrations/add-integrations.mdx:35–63 — the Popular Integrations section lists generic capability bullets (e.g. "Monitor channels for specific messages") without any guidance on how to actually enable those capabilities. Readers who want to connect Slack already clicked through from the integration catalog — this section adds length without adding how. Either link to the dedicated integration pages (if they exist under /integrations/popular-integrations/) or cut the section and let the integration-specific pages carry that detail.
✅ Clean files (0)

Both files have issues.

🔋 Credit usage
Item Count
Files reviewed 2
Context pages read 2
Total lines processed ~792

Files read: build/invent/invent.mdx (367 lines), integrations/add-integrations.mdx (63 lines), integrations/introduction.mdx (316 lines), integrations/remove-integrations.mdx (46 lines)

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