Skip to content

TSP-1262: Add documentation for integration dependency visibility#650

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

TSP-1262: Add documentation for integration dependency visibility#650
claude[bot] wants to merge 1 commit into
mainfrom
TSP-1262/docs-update

Conversation

@claude
Copy link
Copy Markdown

@claude claude Bot commented Jun 1, 2026

Summary

Documents the new Enterprise-only "Used by" annotations in the Integration Controls panel, introduced in PR #14473. These annotations show which native tool steps depend on each integration, helping admins make informed decisions before toggling or removing integrations.

Changes

integrations/remove-integrations.mdx

  • Added new "Understanding integration dependencies (Enterprise)" section between the how-to steps and Important Considerations, including navigation instructions, concrete examples (Serper → Google Search, Browserless → Web Scrape/Extract Content), and a note that only native tool step dependencies are shown
  • Updated Impact on agents to point Enterprise users to the "Used by" annotations in Integration Controls, with a fallback path for non-Enterprise users
  • Updated FAQ question from "which agents" to "which agents or tools" and split the answer into Enterprise and non-Enterprise paths

enterprise/integration-controls.mdx

  • Added new "Understanding integration dependencies" subsection explaining the "Used by" annotations with the same examples, positioned after the how-to steps

References

Documents the Enterprise-only "Used by" annotations in the Integration
Controls panel (PR #14473). Admins can now see which native tool steps
depend on each integration before toggling or removing it.

- integrations/remove-integrations.mdx: new "Understanding integration
  dependencies (Enterprise)" section, updated Impact on agents bullets,
  updated FAQ to cover both Enterprise and non-Enterprise paths
- enterprise/integration-controls.mdx: new "Understanding integration
  dependencies" subsection with examples

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

mintlify Bot commented Jun 1, 2026

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

Project Status Preview Updated (UTC)
relevanceai 🟢 Ready View Preview Jun 1, 2026, 7:35 AM

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

@linear
Copy link
Copy Markdown

linear Bot commented Jun 1, 2026

TSP-1262

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 1, 2026

🎯 Vibe check

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

Scores

Dimension Score What's holding it back
🔴 Consistency 5/10 remove-integrations.mdx has systematic title-case headings throughout (title, sidebarTitle, 3 × H2) and inconsistent capitalization of "Agent" as a product term.
🟢 Technical clarity 9/10 Steps are precise and reference exact UI elements. Minor: "three dots settings button" (line 19) isn't an official UI label.
🟢 Non-technical clarity 9/10 Plain language, clear prerequisites, good context for Enterprise vs non-Enterprise paths.
🟡 Structure 7/10 FAQ in remove-integrations.mdx uses raw bold text instead of <AccordionGroup> components; sequential steps across the page don't use <Steps>.

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

Overall vibe: The enterprise/integration-controls.mdx page is clean and well-patterned. integrations/remove-integrations.mdx has strong content — the Enterprise dependency visibility section is a useful addition — but it has a systematic sentence-case problem across its title, sidebarTitle, and multiple headings that needs a sweep before merge. The FAQ section also breaks from the <AccordionGroup> pattern used everywhere else in the docs.

🔧 Issues (6)
  • integrations/remove-integrations.mdx:2 — title "Remove Integrations""Remove integrations" (sentence case; only proper nouns/product names capitalize)
  • integrations/remove-integrations.mdx:4 — sidebarTitle "Remove Integrations""Remove integrations"
  • integrations/remove-integrations.mdx:13 — heading ## How to Remove Integrations## How to remove integrations
  • integrations/remove-integrations.mdx:47 — heading ## Important Considerations## Important considerations
  • integrations/remove-integrations.mdx:57 — heading ## Reconnecting Integrations## Reconnecting integrations
  • integrations/remove-integrations.mdx:10,21,51,53,68,72 — "agents" refers to the Relevance AI product throughout, so it should be capitalized: "AI Agents' capabilities" (line 10), "AI Agents will no longer have access" (line 21), ### Impact on Agents (line 51 heading), "Verify which Agents are currently using" (line 53), "which Agents or Tools are using" (line 68), "each Agent's settings" (line 72). Line 54 already uses "Agents" correctly — the rest of the page should match.
🧩 Component suggestions (5)
  • integrations/remove-integrations.mdx:16–20 — numbered list is a sequential procedure; use <Steps> for visual progress indicators (same applies to lines 31–33 and 61–64 — three separate step sequences on this page, all should be <Steps>)
  • integrations/remove-integrations.mdx:66–72 — FAQ is rendered with raw **Q: ...** bold labels and inline bold audience labels (**Enterprise organizations:**, **Non-Enterprise users:**). The companion page integration-controls.mdx uses <AccordionGroup> + <Accordion> for its FAQ, and asset-controls.mdx does the same. Convert to:
    <AccordionGroup>
      <Accordion title="How do I know which Agents or Tools are using a particular integration?">
        **Enterprise organizations:** Navigate to **Settings > Integration controls** ...
        
        **Non-Enterprise users:** Go to each Agent's settings ...
      </Accordion>
    </AccordionGroup>
  • enterprise/integration-controls.mdx:19–23 — numbered list is a sequential procedure; <Steps> would be consistent. (Note: sibling pages like asset-controls.mdx also use plain numbered lists here, so this is a lower-priority suggestion — fixing it across the board in a separate pass would be better than fixing just this one.)
✅ Clean files (1)

enterprise/integration-controls.mdx

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

Files read: enterprise/integration-controls.mdx (42 lines), integrations/remove-integrations.mdx (73 lines), integrations/add-integrations.mdx (59 lines), enterprise/asset-controls.mdx (43 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