Skip to content

docs(TSP-1369): add live sub-agent activity monitoring - #751

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

docs(TSP-1369): add live sub-agent activity monitoring#751
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1369

Conversation

@claude

@claude claude Bot commented Aug 5, 2026

Copy link
Copy Markdown

Summary

  • Added a new Monitoring sub-agent activity section to build/agents/build-your-agent/agent-settings/subagents.mdx, placed after the Communication Settings section
  • Added a cross-reference paragraph to the Task Timeline section of build/workforces/workforce-features/workforce-task-view.mdx

What's documented

When a parent agent spawns a child sub-agent, users now see a live activity card in the Inventor timeline (rather than a static spawn receipt). The new section covers:

  • Status progression: Queued → Starting → Working → Done / Failed / Stopped
  • Live step count and current tool activity shown on the card
  • Expandable view of the child agent's full conversation history (tool steps, outputs, errors)
  • Debug tip: using the expanded view to diagnose failed sub-agent runs
  • Availability: all users, no feature flag

Linear issue

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

🤖 Generated with Claude Code

Add 'Monitoring sub-agent activity' section to subagents.mdx documenting
the real-time activity card that appears in the parent agent's timeline
when a sub-agent is invoked, including status progression table, step
count/tool activity indicators, and expandable conversation history.

Add cross-reference paragraph to workforce-task-view.mdx Task Timeline
section describing the same live activity cards in the workforce context.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude claude Bot added the docs-drafter Documentation drafted by Claude label Aug 5, 2026
@mintlify

mintlify Bot commented Aug 5, 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 Aug 5, 2026, 4:11 AM

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

@linear

linear Bot commented Aug 5, 2026

Copy link
Copy Markdown

TSP-1369

@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

🎯 Vibe check

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

Scores

Dimension Score What's holding it back
🔴 Consistency 2/10 24 heading-case violations across both files — every section heading uses title case instead of sentence case. Three internal links in workforce-task-view.mdx use absolute URLs (violates CLAUDE.md) with British-spelled path segments (customise-agent) and appear to point to non-existent routes.
🟡 Technical clarity 6/10 All three "Related Features" links in workforce-task-view.mdx likely 404 in production (paths don't match any file in the repo). Duplicate "Task View Settings" content in subagents.mdx conflicts with the canonical task-view.mdx page and leaves readers unsure which version to trust.
🟡 Non-technical clarity 7/10 Content is generally well-explained with concrete examples and clear purpose statements. The subagents.mdx page is disorienting — it's tagged LEGACY, warns the feature may be removed, then adds a new live-monitoring section alongside duplicate task-view content.
🟡 Structure 5/10 subagents.mdx lines 102–130 duplicate content from task-view.mdx almost verbatim, violating the "link to canonical source" rule. New monitoring feature content is buried in a deprecated page instead of being anchored to the active workforce-task-view.mdx.

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

Overall vibe: Heading capitalization is broken on every single section across both files — sentence case appears only in the newly-added monitoring subsections of subagents.mdx, which makes the inconsistency very visible. Fix the 24 heading-case violations and the three broken "Related Features" links and this PR is in solid shape; the actual prose is clear and the live-monitoring feature is documented well.

🔧 Issues (28)

subagents.mdx — heading case (11)

  • subagents.mdx:5 — frontmatter description has a trailing space: "Add Subagents to your Agent ""Add Subagents to your Agent"
  • subagents.mdx:17## Sub-Agent Settings## Sub-agent settings
  • subagents.mdx:19### Approval Mode### Approval mode
  • subagents.mdx:31### Max Auto-runs Before Approval### Max auto-runs before approval
  • subagents.mdx:40### Error Handling Behavior### Error handling behavior
  • subagents.mdx:49## Communication Settings## Communication settings
  • subagents.mdx:51### Usage Instructions### Usage instructions
  • subagents.mdx:61### Message Template### Message template
  • subagents.mdx:102## Task View Settings## Task view settings
  • subagents.mdx:104### View Title### View title
  • subagents.mdx:114### Information to Include### Information to include
  • subagents.mdx:124## Why Task Views Matter## Why task views matter

workforce-task-view.mdx — heading case (13)

  • workforce-task-view.mdx:15## Key Features## Key features
  • workforce-task-view.mdx:17### Real-Time Task Monitoring### Real-time task monitoring
  • workforce-task-view.mdx:25### Manual Trigger Activation### Manual trigger activation
  • workforce-task-view.mdx:36### Approval Management### Approval management
  • workforce-task-view.mdx:48### Conversation History### Conversation history
  • workforce-task-view.mdx:62### Task Timeline### Task timeline
  • workforce-task-view.mdx:75### Monitoring Multiple Tasks### Monitoring multiple tasks
  • workforce-task-view.mdx:83### Handling Escalations### Handling escalations
  • workforce-task-view.mdx:93### Approval Workflows### Approval workflows
  • workforce-task-view.mdx:104## Best Practices## Best practices
  • workforce-task-view.mdx:106### Organizing Your Task View### Organizing your Task View
  • workforce-task-view.mdx:113### Effective Monitoring### Effective monitoring
  • workforce-task-view.mdx:129## Related Features## Related features

workforce-task-view.mdx — broken internal links (3)

  • workforce-task-view.mdx:132https://relevanceai.com/docs/build/agents/customise-agent/flowbuilder is an absolute URL (must be root-relative per CLAUDE.md), uses British customise, and the path doesn't exist in the repo. The "Edge Settings" link likely belongs at /build/workforces/build-an-ai-workforce/edge-settings
  • workforce-task-view.mdx:133https://relevanceai.com/docs/build/agents/customise-agent/escalate — same absolute/British issues; the Approvals and Escalations page is at /build/workforces/workforce-features/approvals-and-escalations
  • workforce-task-view.mdx:134https://relevanceai.com/docs/build/agents/customise-agent/subagents — same issues; the Subagents page is at /build/agents/build-your-agent/agent-settings/subagents. Note: the link text says "Workforce Builder" but targets the Subagents page — the link text or target appears wrong
🧩 Component suggestions (1)
  • workforce-task-view.mdx:131–135 — "Related Features" is a plain markdown bullet list of links with descriptions. These are navigable items with parallel structure, which is exactly the pattern <CardGroup> is designed for. Once the broken links above are fixed, convert to:
    <CardGroup cols={2}>
      <Card title="Edge settings" icon="arrow-right-arrow-left" href="/build/workforces/build-an-ai-workforce/edge-settings">
        Configure how agents communicate and interact with each other in your Workforce
      </Card>
      <Card title="Approvals and escalations" icon="circle-check" href="/build/workforces/workforce-features/approvals-and-escalations">
        Set up approval workflows and escalation paths for your Agents
      </Card>
      ...
    </CardGroup>
🏗️ Page structure (2)
  • subagents.mdx:102–130 — "Task View Settings" and "Why Task Views Matter" are nearly verbatim duplicates of the content in task-view.mdx. CLAUDE.md: "Don't duplicate content across pages — link to the canonical source instead." Remove these sections and replace with a short sentence linking to /build/agents/build-your-agent/agent-settings/task-view.

  • subagents.mdx:71–100 — New live-monitoring feature content ("Monitoring sub-agent activity") is added to a page tagged LEGACY with a deprecation warning. This creates an odd experience: the page warns users the feature may be removed, then introduces fresh functionality. The live activity card is also described in workforce-task-view.mdx:70–71. Consider whether this monitoring content belongs on the legacy page at all, or whether workforce-task-view.mdx is the better canonical location for the full breakdown (status table, step count, expandable history).

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

Files read: subagents.mdx (130 lines), workforce-task-view.mdx (136 lines), task-view.mdx (46 lines), visual-data-masking.mdx (390 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