Skip to content

docs(TSP-1233): document Has active tool failures filter#621

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

docs(TSP-1233): document Has active tool failures filter#621
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1233

Conversation

@claude
Copy link
Copy Markdown

@claude claude Bot commented May 12, 2026

Summary

  • Adds a new Filtering tasks by error and status section to task-view.mdx explaining the Has active tool failures filter, how it works alongside Agent has errored, common use cases, and the locked-filter behavior on the Errors tab
  • Adds a Filtering tasks by failure type section to task-queue.mdx with a brief introduction to both filters and a cross-reference to Task View Settings
  • Adds a <Tip> callout to the Tool failures section in troubleshooting-agents-not-working.mdx pointing users to the new filter

Linear issue

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

Add documentation for the new "Has active tool failures" filter option
in the agent task filtering system, including Errors tab behavior and
cross-references across task queue and troubleshooting pages.

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

linear Bot commented May 12, 2026

TSP-1233

@github-actions
Copy link
Copy Markdown
Contributor

🎯 Vibe check

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

Scores

Dimension Score What's holding it back
🔴 Consistency 5/10 Heading capitalization is broken across all three files — most headings in task-queue.mdx violate sentence case, and "agent"/"tool" (Relevance AI product terms) appear lowercase in headings and body text throughout. British spellings "Cancelling"/"Cancelled" in task-queue.mdx. Banned word "leverage" in task-queue.mdx:88.
🟡 Technical clarity 7/10 task-view.mdx has a page title that's a verbatim duplicate of task-overview.mdx — this will confuse readers and break navigation. The multi-paragraph <Warning> callout in troubleshooting-agents-not-working.mdx violates CLAUDE.md rules. A LinkedIn post link is used as a canonical reference and could go dead.
🟡 Non-technical clarity 8/10 The troubleshooting page is well-structured with clear numbered sections. The "Why this matters" pattern in task-view.mdx is helpful. No jargon is dropped cold without context. Minor: the troubleshooting page doesn't explain what "vendor credits" are before referencing the billing model check.
🟡 Structure 7/10 The task-view.mdx page title duplicating task-overview.mdx is the main concern — it affects sidebar labeling and SEO. Otherwise the three pages form a coherent cluster with good cross-references. The task-queue.mdx "Best practices" section uses "leverage" as a bold label that reads like a tip header rather than an action — minor presentation issue.

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

Overall vibe: The filtering-by-failure content across task-view.mdx and task-queue.mdx is well-done — clear, non-redundant, and correctly cross-referenced. The troubleshooting page is solid and comprehensive. The main drag is mechanical: heading sentence case is inconsistently applied in task-queue.mdx, product terms "Agent" and "Tool" slip to lowercase throughout all three files, and there are two American English violations in the same heading.

🔧 Issues (15)

Page title

  • build/agents/build-your-agent/agent-settings/task-view.mdx:2 — Page title is "Give Your Agent Tasks", which is identical to task-overview.mdx's title. The sidebarTitle is already "Tasks View" — update the page title to something like "Task view settings" to match. Also update the two link texts that reference this page as "Task View Settings" (in task-view.mdx:41 and task-queue.mdx:81).

Heading sentence case — task-view.mdx

  • task-view.mdx:11## Task View Settings## Task view settings
  • task-view.mdx:13### View Title### View title
  • task-view.mdx:25### Which Information to Include in the View### Which information to include in the view

Heading sentence case — task-queue.mdx

  • task-queue.mdx:7## Understanding the Task Queue## Understanding the task queue
  • task-queue.mdx:12## How to Access the Task Queue## How to access the task queue
  • task-queue.mdx:27## Task Statuses## Task statuses
  • task-queue.mdx:44## Cancelling Tasks## Canceling tasks (also fixes spelling — see below)
  • task-queue.mdx:64## Viewing Queue Insights## Viewing queue insights

Heading sentence case — troubleshooting-agents-not-working.mdx

  • troubleshooting-agents-not-working.mdx:43#### Step 1: Test the tool independently#### Step 1: Test the Tool independently ("Tool" = Relevance AI product term)
  • troubleshooting-agents-not-working.mdx:62#### Step 2: Check agent-to-tool communication#### Step 2: Check Agent-to-Tool communication
  • troubleshooting-agents-not-working.mdx:74#### Common tool input issues#### Common Tool input issues
  • troubleshooting-agents-not-working.mdx:90#### Check agent settings#### Check Agent settings
  • troubleshooting-agents-not-working.mdx:121### Understanding agent behavior### Understanding Agent behavior
  • troubleshooting-agents-not-working.mdx:127### Improving your agent prompt### Improving your Agent prompt

Product term capitalization — body text

  • task-view.mdx (lines 27, 31, 39, 52, 53, 61) — "tools"/"tool" referring to Relevance AI Tools → capitalize: "Tools"/"Tool". E.g. "select specific tools or information sources" → "select specific Tools or information sources"; "Type the name of a tool your Agent uses" → "Type the name of a Tool your Agent uses".
  • task-queue.mdx (lines 9, 15, 24, 28) — "agent"/"agents"/"triggers" → "Agent"/"Agents"/"Triggers". E.g. "when you set up triggers or create bulk schedules for your agent" → "when you set up Triggers or create bulk schedules for your Agent".
  • troubleshooting-agents-not-working.mdx (lines 38, 46, 49, 51, 64) — "agents"/"tools" → "Agents"/"Tools" when referring to Relevance AI product features. E.g. "When agents fail, it's often because one of their tools is not working properly" → "When Agents fail, it's often because one of their Tools is not working properly".

American English

  • task-queue.mdx:44 — Heading: "Cancelling" → "Canceling"
  • task-queue.mdx:35 — Body: "Cancelled" → "Canceled"

Banned word

  • task-queue.mdx:88"Leverage the queue insights" — "leverage" is banned. Replace with "Use the queue insights" or "Check queue insights".

Callout structure

  • troubleshooting-agents-not-working.mdx:184–188<Warning> contains two separate paragraphs. CLAUDE.md requires callouts to be a single short paragraph. The second paragraph (about Enterprise demo) should be moved outside the callout as plain prose, or both paragraphs condensed into one sentence.
🧩 Component suggestions (2)
  • task-view.mdx:29–33 — The "How it works" block uses a plain numbered list. For a sequential three-step procedure in the UI, <Steps> adds progress indicators that make the flow clearer. Consider wrapping lines 29–33 in <Steps>.

  • troubleshooting-agents-not-working.mdx:146 — The <Info> callout links to a specific LinkedIn post (urn:li:activity:...) as a canonical "deeper understanding" reference. External post links rot — if the co-founder's article has a more stable home (blog post, docs page), prefer that. If the LinkedIn link must stay, don't frame it as the authoritative resource.

🏗️ Page structure (1)
  • build/agents/build-your-agent/agent-settings/task-view.mdx — The page title "Give Your Agent Tasks" is identical to the task-overview.mdx title in the same directory, which creates a duplicate in navigation and confuses search. The sidebarTitle "Tasks View" correctly describes the page content. Align the page title with the sidebarTitle — something like "Task view settings" — and update the two inbound link texts that call it "Task View Settings".
✅ Clean files (0)

All three files have at least one issue. No fully clean files in this PR.

🔋 Credit usage
Item Count
Files reviewed 3
Context pages read 3
Total lines processed ~846

Files read: task-view.mdx (77 lines), task-queue.mdx (93 lines), troubleshooting-agents-not-working.mdx (199 lines), task-overview.mdx (94 lines), general.mdx (249 lines), troubleshooting-browser-issues.mdx (134 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