Skip to content

docs(TSP-1257): Add FullEnrich native integration documentation#644

Open
claude[bot] wants to merge 2 commits into
mainfrom
docs/TSP-1257
Open

docs(TSP-1257): Add FullEnrich native integration documentation#644
claude[bot] wants to merge 2 commits into
mainfrom
docs/TSP-1257

Conversation

@claude
Copy link
Copy Markdown

@claude claude Bot commented Jun 1, 2026

Summary

  • Adds integrations/popular-integrations/fullenrich.mdx documenting the native FullEnrich B2B contact enrichment integration
  • Covers connection setup, 5 native tool steps (enrich contacts, check credit balance, verify API key, start enrichment job, retrieve enrichment results), use cases, best practices, and FAQs
  • Highlights that this native integration replaces the previous Pipedream-based FullEnrich actions
  • Includes feature flag rollout note for workspaces where FullEnrich hasn't appeared yet
  • Updates docs.json to add the page under Integrations > Popular integrations

Linear issue

https://linear.app/relevance/issue/TSP-1257/

🤖 Generated with Claude Code

Adds documentation page for the native FullEnrich B2B contact enrichment integration, covering connection setup, 5 tool steps (enrich contacts, check credit balance, verify API key, start/retrieve enrichment jobs), use cases, best practices, and FAQs. Updates docs.json navigation to include the new page.

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
Copy link
Copy Markdown

linear Bot commented Jun 1, 2026

TSP-1257

@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 9/10 fullenrich.com appears twice as unlinked plain text (lines 28, 136) — sibling pages always use proper [text](URL) hyperlinks for third-party signup URLs. No banned words, no British spellings, sentence case is clean throughout.
🟢 Technical clarity 9/10 Instructions are specific, FAQs cover real edge cases (no-match handling, async vs sync enrichment, credit pre-checks). The unlinked fullenrich.com references are slightly less useful than working links.
🟢 Non-technical clarity 9/10 Strong intro that defines FullEnrich plainly. The "waterfall approach" term is explained inline ("FullEnrich checks 20+ data providers in sequence"). Use cases are concrete.
🟡 Structure 8/10 The "Contact enrichment" subsection has one card inside a cols={2} CardGroup — a single-card two-column group is visually awkward. Minor relative to the overall solid page structure.

Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5. Scores are a single overall judgment across the whole PR.

Overall vibe: This is a clean, practical integration page that notably avoids the banned words ("seamlessly", "leverage") that appear in sibling pages like firmable.mdx and lusha.mdx — a real improvement. Two unlinked plain-text fullenrich.com references are the main fix needed, plus a minor component layout issue.

🔧 Issues (2)
  • integrations/popular-integrations/fullenrich.mdx:28fullenrich.com is plain text, not a hyperlink. Sibling pages link external signup URLs: [sign up at FullEnrich](https://www.fullenrich.com/). Same pattern as firmable.mdx:24 and lusha.mdx:24.
  • integrations/popular-integrations/fullenrich.mdx:136fullenrich.com is again plain text. Same fix: [sign up at fullenrich.com](https://www.fullenrich.com/).
🧩 Component suggestions (1)
  • integrations/popular-integrations/fullenrich.mdx:40–44<CardGroup cols={2}> contains only one card ("Enrich contacts"). A two-column group with a single card leaves a visually empty column. Either add cols={1} or drop the cols attribute to let Mintlify default it, or move this lone card up to sit alongside the most related pair below (e.g. merge into the "Account & authentication" group if that makes conceptual sense).
✅ Clean files (1)

docs.json — FullEnrich is correctly added to the data enrichment group after firmable, placement is logical, JSON is valid.

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

Files read: integrations/popular-integrations/fullenrich.mdx (167 lines), integrations/popular-integrations/firmable.mdx (369 lines), integrations/popular-integrations/lusha.mdx (348 lines), docs.json (~100 lines, partial)

@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:22 AM

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

There is no separate 'Start enrichment job' step and no synchronous enrich
path. Per api-node PR #14924, the five native steps are Enrich contacts
(starts an async job, returns an enrichment ID), Retrieve enrichment results,
Check credit balance, Verify API key, and a generic FullEnrich API call.
Reframed the cards, batch/async best practices, and FAQ accordingly.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 3, 2026

🎯 Vibe check

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

Scores

Dimension Score What's holding it back
🟡 Consistency 6/10 "agent"/"agents" is lowercase throughout when referring to the Relevance AI Agent product (~13 instances); "tools and agents" on line 7 should be "Tools and Agents"; two card descriptions are missing terminal periods; one unlinked domain reference.
🟢 Technical clarity 9/10 Clear step-by-step connection flow; async enrichment two-step pattern explained well in multiple places; edge cases (no-match, credit exhaustion, mid-job failures) are called out. Minor: signup URL on line 28 is unlinked text, unlike sibling pages.
🟢 Non-technical clarity 9/10 Plain-English intro, practical use cases, no jargon dumps. The FAQ is genuinely useful and doesn't just echo the marketing copy.
🟢 Structure 9/10 Logical flow from connection → tool steps → use cases → best practices → FAQ. Accordion usage is appropriate. One minor oddity: a single-card <CardGroup> in the Advanced section.

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

Overall vibe: Solid integration page — well-structured, technically accurate, and the async enrichment gotcha is explained clearly in both the use cases and the FAQ. The main thing holding it back is the pervasive lowercase "agent" throughout: every time the page says "create an agent" or "build your agent" it's talking about a Relevance AI Agent (the product) and should be capitalized.

🔧 Issues (16)

Product term capitalization — "agent" / "agents" (13 instances)

All of these refer to Relevance AI Agents (the product) and should be capitalized:

  • integrations/popular-integrations/fullenrich.mdx:7 — "enrich contacts inside tools and agents" → "Tools and Agents"
  • integrations/popular-integrations/fullenrich.mdx:37 — "your agents can use" → "your Agents can use"
  • integrations/popular-integrations/fullenrich.mdx:37 — "your agent's workflows" → "your Agent's workflows"
  • integrations/popular-integrations/fullenrich.mdx:76 — "Create an agent that takes" → "Create an Agent that takes"
  • integrations/popular-integrations/fullenrich.mdx:80 — "Build an agent that connects" → "Build an Agent that connects"
  • integrations/popular-integrations/fullenrich.mdx:84 — "Deploy an agent that enriches" → "Deploy an Agent that enriches"
  • integrations/popular-integrations/fullenrich.mdx:88 — "your agent to fetch" → "your Agent to fetch"
  • integrations/popular-integrations/fullenrich.mdx:96 — "Build an agent that checks" → "Build an Agent that checks"
  • integrations/popular-integrations/fullenrich.mdx:108 — "Build your agent to flag" → "Build your Agent to flag"
  • integrations/popular-integrations/fullenrich.mdx:112 — "your agent can pause" → "your Agent can pause"
  • integrations/popular-integrations/fullenrich.mdx:116 — "Design your agent to fetch" → "Design your Agent to fetch"
  • integrations/popular-integrations/fullenrich.mdx:120 — "your agent" → "your Agent" (two occurrences on this line)
  • integrations/popular-integrations/fullenrich.mdx:152 — "your agent can pause" → "your Agent can pause"
  • integrations/popular-integrations/fullenrich.mdx:156 — "Your agent should handle" → "Your Agent should handle"

Missing terminal periods on card descriptions

  • integrations/popular-integrations/fullenrich.mdx:52–53 — "Check the remaining FullEnrich credits available on the connected account" — missing period. The other four cards all end with periods.
  • integrations/popular-integrations/fullenrich.mdx:54–55 — "Validate that the connected FullEnrich API key is active and working" — missing period.

Unlinked domain reference

  • integrations/popular-integrations/fullenrich.mdx:28 — "you can sign up at fullenrich.com" — bare domain, not hyperlinked. Lusha and Firmable sibling pages both link their equivalent signup references. Should be [sign up at FullEnrich](https://fullenrich.com).
🧩 Component suggestions (1)
  • integrations/popular-integrations/fullenrich.mdx:59–64 — The "Advanced" section wraps a single card in <CardGroup cols={2}>. A CardGroup with one card is visually odd (renders half-width on a two-column grid). Either drop the <CardGroup> wrapper and use a bare <Card> directly, or accept it as-is knowing it matches the pattern used in sibling pages like Firmable.
✅ Clean files (1)

docs.json — FullEnrich entry correctly placed in the data enrichment group within popular-integrations, after firmable and before the communications group. Valid JSON, no navigation issues.

🔋 Credit usage
Item Count
Files reviewed 2
Context pages read 2 (lusha.mdx, firmable.mdx)
Total lines processed ~535

Files read: integrations/popular-integrations/fullenrich.mdx (167 lines), integrations/popular-integrations/lusha.mdx (347 lines), integrations/popular-integrations/firmable.mdx (368 lines), docs.json (100 lines, header only)

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