Skip to content

docs(TSP-1266): Add Tool Library documentation and legacy filter docs#654

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

docs(TSP-1266): Add Tool Library documentation and legacy filter docs#654
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1266

Conversation

@claude

@claude claude Bot commented Jun 1, 2026

Copy link
Copy Markdown

Summary

  • Creates build/tools/tool-library.mdx: a new page documenting the Tool Library interface, including search, the cloneable/embeddable filters, and the new Contains legacy tool-steps filter introduced in PR #15255
  • Adds a cross-reference in integrations/introduction.mdx pointing users to the Tool Library filter when reviewing native vs. Pipedream integrations
  • Adds a brief Tool Library mention in build/tools/tool-steps/getting-started.mdx so users know they can browse existing tools before building
  • Registers the new page in docs.json at the top of the Tools navigation group

Resolves: https://linear.app/relevance/issue/TSP-1266/
Related product PR: #15255

Test plan

  • Verify build/tools/tool-library renders correctly in Mintlify preview
  • Confirm all internal links resolve (/integrations/introduction, /build/tools/tool-library)
  • Check sentence-case headings throughout new page
  • Confirm new page appears in the sidebar under Tools
  • Confirm callouts render without attributes (no <Note type=...>)

🤖 Generated with Claude Code

Documents the Tool Library interface including the new "Contains legacy
tool-steps" filter (PR #15255), which helps users identify tools built
on Pipedream-based steps that have native replacements available.
Adds cross-references from integrations/introduction and tool-steps
getting-started pages, and registers the new page 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-1266

@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, 10:00 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 (3 MDX + 1 docs.json nav change) — 3 with issues, 1 clean

Scores

Dimension Score What's holding it back
🟡 Consistency 6/10 Pre-existing issues in integrations/introduction.mdx (which was touched): multiple banned words ("powerful" ×4, "leverage"), heading title case on three headings. New content in tool-library.mdx is clean except one capitalization miss.
🟢 Technical clarity 8/10 New content is precise and references real UI element names. Pre-existing absolute internal URLs in integrations/introduction.mdx related-features section should be root-relative.
🟢 Non-technical clarity 8/10 tool-library.mdx explains each filter's purpose clearly. The migration rationale section is useful. No unexplained jargon.
🟢 Structure 8/10 tool-library.mdx is well-structured for a reference page. Nav placement (first in Tools group) is sensible. ## URL bookmarking section slightly redundant with the <Tip> above it, but the URL parameter detail is new value.

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

Overall vibe: The new tool-library.mdx page is the highlight — clean, specific, well-scoped, with a clear migration path. The two additions to existing files are minimal and correct. The consistency score drag is entirely pre-existing debt in integrations/introduction.mdx; since that file was touched, it's flagged here so it can be cleaned up alongside.

🔧 Issues (9)

New content (this PR):

  • build/tools/tool-library.mdx:28 — heading ## Legacy tool-steps has lowercase "t" in "tool-steps". The rest of the docs capitalize "Tool" as a product feature (see tool-steps.mdx headings: "LLM Tool steps", "Knowledge Tool steps"). Change to ## Legacy Tool steps. Note: the inline UI label reference **Contains legacy tool-steps** is correct as-is — that's quoting the actual filter name.

Pre-existing in integrations/introduction.mdx (flagged because the file was modified in this PR):

  • integrations/introduction.mdx:4 — page description uses "powerful" (banned word): "to create powerful, automated workflows across your entire tech stack" → drop "powerful" entirely or rewrite as "automated workflows that span your tech stack"
  • integrations/introduction.mdx:115 — "leverage" is a banned word: "This capability allows you to leverage your existing LLM subscriptions" → "This lets you use your existing LLM subscriptions"
  • integrations/introduction.mdx:212 — heading ### Examples of Powerful Integration Actions: has two problems: "Powerful" is a banned word, and "Powerful Integration Actions" is title case. Change to ### Integration actions by service or similar.
  • integrations/introduction.mdx:251 — "powerful" banned word: "the building blocks of powerful workflows" → "the building blocks of complex workflows"
  • integrations/introduction.mdx:269 — heading ## Creating Powerful Cross-Platform Workflows uses title case and "Powerful" (banned word) → ## Creating cross-platform workflows
  • integrations/introduction.mdx:122 — heading ### How to Set Up Triggers: is title case → ### How to set up triggers
  • integrations/introduction.mdx:159 — heading ### Common Trigger Examples: is title case → ### Common trigger examples
  • integrations/introduction.mdx:293–297 — "Related Features" links use absolute URLs (https://relevanceai.com/docs/...) instead of root-relative paths. CLAUDE.md requires root-relative internal links. Change to e.g. /build/agents/build-your-agent/agent-triggers/integrations, /get-started/core-concepts/tools, /build/agents/agent-configuration.
🧩 Component suggestions (1)
  • build/tools/tool-steps/getting-started.mdx:33–40 — pre-existing <Tip> contains a numbered list with 4 items and bold formatting inside. CLAUDE.md is explicit: callouts must be a single short paragraph — no bullet lists, no multi-line content. This content is genuinely useful reference material; lift it out of the callout into a ## Working with Tool steps section and use a plain numbered list (or <Steps> if sequential procedure framing helps). The file was touched in this PR so it's worth cleaning up.
⚠️ Contradictions (0)

No contradictions found. The new tool-library.mdx and the updated integrations/introduction.mdx describe the native vs. Pipedream distinction consistently, and cross-link each other correctly.

✅ Clean files (1)

docs.json — nav addition is correctly placed and valid JSON.

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

Files read: build/tools/tool-library.mdx (64 lines), build/tools/tool-steps/getting-started.mdx (58 lines), integrations/introduction.mdx (320 lines), docs.json (partial, ~30 lines), build/tools/tool-steps.mdx (117 lines), build/tools/what-are-chains.mdx (19 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