Skip to content

docs(TSP-1347): document By Agent grouped view for task monitoring#726

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

docs(TSP-1347): document By Agent grouped view for task monitoring#726
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1347

Conversation

@claude

@claude claude Bot commented Jul 15, 2026

Copy link
Copy Markdown

Summary

Documents the By Agent grouped view expand-row feature added in RelevanceAI/builder#16120.

  • Workforce Task View page (build/workforces/workforce-features/workforce-task-view.mdx): Replaced the vague "Expand individual tasks to see detailed information" bullet with a new #### By agent grouped view subsection under "Monitoring multiple tasks". The subsection explains the expand chevron interaction, 25-task pagination with a Show more button, task detail drawer access, filter/search syncing, and loading/error/empty states.
  • Task Operations page (build/agents/give-your-agent-tasks/tasks-page.mdx): Added a new ## By agent view section documenting the same grouped view, expand-row behavior, pagination, drawer interaction, filter sync, and sub-table states.

Linear issue

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

Test plan

  • Verify both pages render correctly on Mintlify preview
  • Check all headings are sentence case
  • Confirm no broken internal links introduced

🤖 Generated with Claude Code

Add documentation for the expand-row feature in the By Agent grouped
view: nested task sub-table with 25-task pagination, Show more button,
task detail drawer interaction, filter/search sync, and loading/error/
empty states.

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

linear Bot commented Jul 15, 2026

Copy link
Copy Markdown

TSP-1347

@github-actions

Copy link
Copy Markdown
Contributor

🎯 Vibe check

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

Scores

Dimension Score What's holding it back
🔴 Consistency 4/10 workforce-task-view.mdx has 11 heading capitalization violations — nearly every H3 and H4 is title case when it should be sentence case. Three absolute URLs where root-relative paths are required. One heading case issue in tasks-page.mdx.
🟡 Technical clarity 7/10 tasks-page.mdx uses bold text as a pseudo-heading (**Sub-table states:**) instead of a proper heading. workforce-task-view.mdx references the UI vaguely in places ("Navigate to the 'Task' section") without naming exact UI elements.
🟡 Non-technical clarity 7/10 workforce-task-view.mdx frontmatter description reads like boilerplate ("centralized interface for monitoring, managing, and interacting"). The "Key Features" and "Working with the Task View" sections cover overlapping territory, which can confuse a reader looking for a clear path through the page.
🟡 Structure 6/10 workforce-task-view.mdx duplicates the "By Agent grouped view" description verbatim from tasks-page.mdx — violates the CLAUDE.md rule to link to canonical sources rather than copy content. The Best Practices section is generic enough to apply to any task-monitoring UI and adds little value here.

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

Overall vibe: tasks-page.mdx is tight and well-scoped — minimal edits needed. workforce-task-view.mdx needs a heading-case pass across the whole file, a link audit, and a structural edit to cut the duplicated "By Agent" content in favour of a cross-link to the canonical description in tasks-page.mdx.

🔧 Issues (15)

Heading capitalization — workforce-task-view.mdx (11 violations)

  • workforce-task-view.mdx:14## Key Features## Key features
  • workforce-task-view.mdx:15### Real-Time Task Monitoring### Real-time task monitoring
  • workforce-task-view.mdx:25### Manual Trigger Activation### Manual trigger activation
  • workforce-task-view.mdx:38### Approval Management### Approval management
  • workforce-task-view.mdx:49### Conversation History### Conversation history
  • workforce-task-view.mdx:62### Task Timeline### Task timeline
  • workforce-task-view.mdx:81#### By agent grouped view#### By Agent grouped view ("Agent" is a Relevance AI product term)
  • workforce-task-view.mdx:96### Handling Escalations### Handling escalations
  • workforce-task-view.mdx:108### Approval Workflows### Approval workflows
  • workforce-task-view.mdx:119### Organizing Your Task View### Organizing your Task View
  • workforce-task-view.mdx:128### Effective Monitoring### Effective monitoring

Heading capitalization — tasks-page.mdx (1 violation)

  • tasks-page.mdx:41## By agent view## By Agent view ("Agent" is a Relevance AI product term; the file itself capitalizes it in the body text on line 43)

Bold text used as heading

  • tasks-page.mdx:51**Sub-table states:** is bold text masquerading as a heading. CLAUDE.md prohibits this. Use ##### Sub-table states instead.

Absolute URLs (should be root-relative)

  • workforce-task-view.mdx:145https://relevanceai.com/docs/build/agents/customise-agent/flowbuilder/build/agents/customise-agent/flowbuilder
  • workforce-task-view.mdx:146https://relevanceai.com/docs/build/agents/customise-agent/escalate/build/agents/customise-agent/escalate
  • workforce-task-view.mdx:147https://relevanceai.com/docs/build/agents/customise-agent/subagents/build/agents/customise-agent/subagents
🧩 Component suggestions (5)
  • workforce-task-view.mdx:9–12 — The "Accessing" section has two numbered steps using plain markdown. Use <Steps> for sequential procedures — it adds visual progress indicators that plain numbered lists don't.
  • workforce-task-view.mdx:29–33 — "Manual trigger activation" four-step procedure → <Steps>.
  • workforce-task-view.mdx:40–44 — "Approval management" four-step procedure → <Steps>.
  • workforce-task-view.mdx:98–104 — "Handling escalations" five-step procedure → <Steps>.
  • workforce-task-view.mdx:109–115 — "Approval workflows" six-step procedure → <Steps>.
🏗️ Page structure (3)
  • workforce-task-view.mdx:81–94 — The "By Agent grouped view" sub-section (lines 81–94) is nearly verbatim copy of tasks-page.mdx:42–55. CLAUDE.md: "Don't duplicate content across pages — link to the canonical source instead." Cut this sub-section and replace with a sentence pointing to the canonical description: e.g. "See Task Operations for how the By Agent grouped view works, including sub-table states and pagination."

  • workforce-task-view.mdx — "Key Features" (lines 15–68) and "Working with the Task View" (lines 70–115) cover substantially the same territory: monitoring, approvals, and escalations both appear in each section. Consider collapsing these: describe each feature once, then link to the dedicated approval/escalation pages for deeper guidance rather than restating the steps here.

  • workforce-task-view.mdx:117–141 — The "Best Practices" section is generic enough to apply to any task-monitoring UI (archive regularly, use filters, check for bottlenecks). If there are no Workforce-specific gotchas here, remove the section or fold the one non-obvious tip (archive completed tasks to keep the interface clean) into a <Tip> callout rather than a full section.

✅ Clean files (1)

build/agents/give-your-agent-tasks/tasks-page.mdx — aside from the heading case and bold-text-heading issues flagged above, this file is well-written: focused scope, accurate product term usage, clear edge-case callouts (bulk action exclusion for multi-approval tasks, empty/error/loading sub-table states), and no banned words.

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

Files read: tasks-page.mdx (55 lines), workforce-task-view.mdx (149 lines), task-overview.mdx (53 lines), approvals-and-escalations.mdx (145 lines)

@mintlify

mintlify Bot commented Jul 15, 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 Jul 15, 2026, 4:54 AM

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

@mintlify

mintlify Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
relevanceai 🟡 Building Jul 15, 2026, 4:52 AM

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

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