Skip to content

Add migration wizard documentation for legacy integrations#653

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

Add migration wizard documentation for legacy integrations#653
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1263

Conversation

@claude

@claude claude Bot commented Jun 1, 2026

Copy link
Copy Markdown

Summary

  • Adds /integrations/migrate-legacy-integrations — a new page documenting the migration wizard for upgrading legacy Pipedream-based tool integrations to native integrations
  • Updates /integrations/introduction to reference the new migration guide in the "Native vs. Pipedream integrations" section
  • Updates /integrations/add-integrations to note that a migration prompt may appear for tools with legacy integrations
  • Adds the new page to docs.json navigation (between Add Integrations and Remove Integrations)

Closes https://linear.app/relevance/issue/TSP-1263/

Test plan

  • New page renders correctly with Steps, CardGroup, and AccordionGroup components
  • All internal links resolve (particularly /get-started/support and /integrations/migrate-legacy-integrations)
  • Navigation in sidebar shows the new page in the correct position
  • Callout blocks in updated pages display without errors

🤖 Generated with Claude Code

…tions

Add a new page explaining how to migrate Pipedream-based tool integrations to
native integrations using the migration wizard. Update the integrations
introduction and add-integrations pages to reference the new guide, and add
the page to the navigation in docs.json.

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
@linear

linear Bot commented Jun 1, 2026

Copy link
Copy Markdown

TSP-1263

@mintlify

mintlify Bot commented Jun 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 Jun 1, 2026, 7:41 AM

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

@github-actions

github-actions Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 4 files (2 MDX files with issues, 1 clean MDX file, 1 navigation JSON with no issues)

Scores

Dimension Score What's holding it back
🔴 Consistency 4/10 Banned words appear 6 times across two files ("powerful" ×4, "leverage" ×2). introduction.mdx has ~9 H2/H3 headings in title case. add-integrations.mdx has 5 heading case violations including the page title and sidebarTitle.
🟡 Technical clarity 7/10 Three internal links in introduction.mdx use absolute URLs instead of root-relative paths (CLAUDE.md violation). Sequential numbered steps in two files don't use <Steps>, missing the visual progress indicators.
🟡 Non-technical clarity 7/10 "This is where integrations truly shine!" and "building blocks of powerful workflows" lean marketing. Definitions are otherwise adequate. migrate-legacy-integrations.mdx reads clearly throughout.
🟡 Structure 6/10 introduction.mdx uses a non-standard numbered heading style (## 1., ## 2.). Several multi-step procedures use plain numbered lists instead of <Steps>. Intro/concept page has no closing CTA. The "Related Features" section duplicates sidebar navigation.

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

Overall vibe: migrate-legacy-integrations.mdx is production-ready — clean steps, correct capitalization, well-placed callouts, no banned words. The other two content pages need substantial cleanup before shipping: introduction.mdx has banned words embedded in both the description and multiple headings, and nearly every H2/H3 is title case rather than sentence case. add-integrations.mdx has the same heading-case pattern plus a banned word in its description.

🔧 Issues (25)

add-integrations.mdx

  • integrations/add-integrations.mdx:2title: "Add Integrations""Add integrations" (sentence case; "integrations" is not a listed product name)
  • integrations/add-integrations.mdx:3 — description contains banned word "powerful" ("powerful workflow automation tools") — rewrite to describe what integrations actually do
  • integrations/add-integrations.mdx:4sidebarTitle: "Add Integrations""Add integrations" (same fix as title)
  • integrations/add-integrations.mdx:11## Setting Up Integrations## Setting up integrations
  • integrations/add-integrations.mdx:35## Popular Integrations## Popular integrations
  • integrations/add-integrations.mdx:37### Slack Integration### Slack integration
  • integrations/add-integrations.mdx:49### Google Calendar Integration### Google Calendar integration
  • integrations/add-integrations.mdx:55### HubSpot Integration### HubSpot integration

integrations/introduction.mdx

  • integrations/introduction.mdx:4 — description contains banned word "powerful" ("create powerful, automated workflows")
  • integrations/introduction.mdx:35## 1. Connecting Integrations## 1. Connecting integrations
  • integrations/introduction.mdx:37 — "The first step in leveraging integrations…" — banned word "leverage"
  • integrations/introduction.mdx:115 — "allows you to leverage your existing LLM subscriptions" — banned word "leverage" (second instance)
  • integrations/introduction.mdx:117## 2. Setting Up Triggers## 2. Setting up Triggers ("Triggers" is a product name; "Up" is not)
  • integrations/introduction.mdx:121### How to Set Up Triggers:### How to set up Triggers (fix case; remove trailing colon)
  • integrations/introduction.mdx:159### Common Trigger Examples:### Common trigger examples (fix case; remove trailing colon)
  • integrations/introduction.mdx:168## 3. Tools & Tool Steps (Actions)## 3. Tools & tool steps (actions)
  • integrations/introduction.mdx:170 — "This is where integrations truly shine!" — marketing language; delete or replace with a plain transition sentence
  • integrations/introduction.mdx:172### How to Add Integration Actions to Your Agent:### How to add integration actions to your Agent (fix case; remove trailing colon)
  • integrations/introduction.mdx:212### Examples of Powerful Integration Actions: — banned word "Powerful"; fix case and remove colon → ### Examples of integration actions
  • integrations/introduction.mdx:251 — "building blocks of powerful workflows" — banned word "powerful"
  • integrations/introduction.mdx:255## 4. Using the Integration's API Tool Step (Advanced)## 4. Using the integration's API Tool Step (advanced) ("Tool Step" is a product concept; "advanced" is not)
  • integrations/introduction.mdx:269## Creating Powerful Cross-Platform Workflows — banned word "Powerful"; fix case → ## Creating cross-platform workflows
  • integrations/introduction.mdx:283## Best Practices for Using Integrations## Best practices for using integrations
  • integrations/introduction.mdx:293## Related Features## Related features
  • integrations/introduction.mdx:295–299 — Three internal links use absolute URLs (https://relevanceai.com/docs/...) — CLAUDE.md requires root-relative paths. Change to /build/agents/customise-agent/triggers, /get-started/core-concepts/tools, and /build/agents/agent-configuration respectively.
🧩 Component suggestions (5)
  • integrations/add-integrations.mdx:27–33 — "Adding Triggers to Agents" section has a plain numbered list for a sequential procedure. Convert to <Steps> so each step gets a visual progress indicator. The steps already have natural titles: "Go to the Agent Settings page", "Select Agent Profile", etc.

  • integrations/introduction.mdx:123–128 — "How to Set Up Triggers" plain numbered list is a sequential procedure → convert to <Steps> (same step titles already exist inline).

  • integrations/introduction.mdx:173–181 — "How to Add Integration Actions to Your Agent" plain numbered list → <Steps>. Eight steps with distinct actions benefit from the visual scaffolding.

  • integrations/introduction.mdx:212–250 — The action examples for Slack, Google Calendar, HubSpot, and Notion are four separate bullet lists under bold subsection headers. These are optional reading that interrupt the page flow. Wrap the group in an <AccordionGroup> with one accordion per integration (e.g. <Accordion title="Slack integration actions">).

  • integrations/introduction.mdx:270–282 — The lead-nurturing cross-platform workflow example (steps 1–6) is long enough to disrupt reading flow inline. Wrap in <Accordion title="Example: automating a lead nurturing workflow"> to keep it optional reading.

🏗️ Page structure (3)
  • integrations/introduction.mdx — Numbered heading style (## 1. Connecting Integrations, ## 2. Setting Up Triggers, etc.) is non-standard and not used elsewhere in the repo. These would be cleaner as plain headings without the numeric prefix, which is already provided by the document structure.

  • integrations/introduction.mdx:293–299 — "Related Features" section links to three pages that are already reachable from the sidebar navigation. CLAUDE.md prohibits "Quick Links sections that duplicate sidebar navigation." Remove the section, or replace it with a proper closing CTA (since this is a concept/intro page) pointing to /integrations/add-integrations and /integrations/migrate-legacy-integrations.

  • integrations/introduction.mdx — No closing CTA. As a concept/overview page, it should end with a clear next step. A ## What's next? section linking to /integrations/add-integrations (to connect a first integration) and /integrations/migrate-legacy-integrations (if the reader has legacy tools) would round it off.

✅ Clean files (2)

integrations/migrate-legacy-integrations.mdx, docs.json

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

Files read: integrations/add-integrations.mdx (63 lines), integrations/introduction.mdx (319 lines), integrations/migrate-legacy-integrations.mdx (82 lines), integrations/remove-integrations.mdx (46 lines), build/agents/build-your-agent/agent-triggers/integrations.mdx (38 lines)

@jordanc-relevanceai

Copy link
Copy Markdown
Collaborator

Consolidated into #660 (legacy-integration docs: migration wizard + Tool Library filter). Closing in favor of that PR.

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