Skip to content

docs: Add By Agent grouped view with drill-down functionality (TSP-1345)#723

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

docs: Add By Agent grouped view with drill-down functionality (TSP-1345)#723
claude[bot] wants to merge 1 commit into
mainfrom
TSP-1345/docs-update

Conversation

@claude

@claude claude Bot commented Jul 15, 2026

Copy link
Copy Markdown

Summary

  • Documents the new By Agent grouped view in the task monitoring interface, introduced in PR #16029
  • Adds a "Grouped view by agent" section to task-overview.mdx explaining how to expand an agent row to drill into individual tasks
  • Adds the same section to workforce-task-view.mdx for workforce-level task monitoring
  • Fixes title-case headings throughout workforce-task-view.mdx to match docs sentence-case standards

Changes

Both pages now document:

  • The By Agent grouping option that shows one summary row per agent
  • Clicking the expand arrow to open a nested task list for that agent
  • Pagination: 25 tasks per page with a Show more button for cursor-based pagination
  • Clicking any task row in the expanded list opens the task detail drawer
  • Active filters and search terms carry through to the nested task list

Linear issue

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

Test plan

  • Verify both pages render correctly in Mintlify preview
  • Confirm new sections appear in the correct location within each page
  • Check all headings are in sentence case

🤖 Generated with Claude Code

Documents the new expand-row drill-down feature for agent-grouped task
views, added in PR #16029. Users can now click the expand arrow on an
agent row to see that agent's individual tasks (up to 25 per page with
cursor-based pagination), with filters and search applying to the nested
list. Also fixes title-case headings in workforce-task-view.mdx to
sentence case per docs standards.

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-1345

@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 6/10 workforce-task-view.mdx has repeated lowercase product terms (Agent, Task, Tool) throughout body text and three heading title-case violations (## Key Features, ## Best Practices, ## Related Features). task-overview.mdx has two lowercase slips in the grouped view section.
🟡 Technical clarity 7/10 workforce-task-view.mdx uses absolute URLs for 3 internal links (lines 136–138) instead of root-relative paths. UI references in that file are less precise than in task-overview.mdx.
🟡 Non-technical clarity 7/10 workforce-task-view.mdx has no opening body paragraph — the page jumps straight to "Accessing the Workforce Task View" without defining what it is first. It also has two approval sections (### Approval management and ### Approval workflows) that cover the same ground, adding confusion.
🟡 Structure 7/10 workforce-task-view.mdx mixes concept and how-to page structures without a clear introduction. Three H2 headings violate sentence case.

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

Overall vibe: task-overview.mdx is clean, focused, and well-structured — it defines the concept up front, gives precise UI references, and cross-links sensibly. workforce-task-view.mdx needs a pass: product term capitalization is inconsistent throughout, three H2 headings are in title case, internal links use absolute URLs, and the page has no opening definition paragraph.

🔧 Issues (16)

Heading case violations

  • workforce-task-view.mdx:14## Key Features## Key features
  • workforce-task-view.mdx:108## Best Practices## Best practices
  • workforce-task-view.mdx:134## Related Features## Related features

Page title / sidebarTitle

  • workforce-task-view.mdx:2–4title: 'Workforce Task View' — "View" is not a listed product term and should follow sentence case. If the feature is officially called "Workforce Task View" (with capital V), that would need to be confirmed with the product team; otherwise: 'Workforce task view'. The same applies to sidebarTitle and to the ## Accessing the Workforce Task View heading at line 7.

Product term capitalization — task-overview.mdx

  • task-overview.mdx:50## Grouped view by agent — "Agent" is a listed product term; heading should read ## Grouped view by Agent
  • task-overview.mdx:52 — "to see an agent-level summary in the task monitoring interface" → "an Agent-level summary in the Task monitoring interface"
  • task-overview.mdx:56 — "opens the task detail drawer" → "Task detail drawer" (if that's the UI label)
  • task-overview.mdx:57 — "nested task list" → "nested Task list"

Product term capitalization — workforce-task-view.mdx

  • workforce-task-view.mdx:31 — "activate the associated agent or process" → "Agent"
  • workforce-task-view.mdx:52 — "interactions between agents and users" → "Agents"
  • workforce-task-view.mdx:53 — "tool usage throughout a task" → "Tool usage throughout a Task"
  • workforce-task-view.mdx:63 — "When tasks were initiated" → "Tasks"
  • workforce-task-view.mdx:65 — "Which agents or tools were involved at each stage" → "Agents or Tools"
  • workforce-task-view.mdx:75–78 — "Tasks are organized", "individual tasks", "different workforces" → capitalize "Tasks" and "Workforces" throughout this section
  • workforce-task-view.mdx:83–85 — "grouping tasks", "per agent in your workforce", "agent's individual tasks", "agent's tasks" → "Tasks", "Agent", "Workforce", "Agent's Tasks"

Links

  • workforce-task-view.mdx:136–138 — Three Related Features links use full absolute URLs (https://relevanceai.com/docs/...). CLAUDE.md requires root-relative paths for internal links. Convert to e.g. /build/agents/build-your-agent/flowbuilder, /build/agents/build-your-agent/escalate, /build/workforces/… (verify the correct paths first).
🧩 Component suggestions (1)
  • workforce-task-view.mdx:56–58 — The <Note> introduces Visual Data Masking as an optional feature to enable. That's closer to a <Tip> than a <Note> (it's a helpful suggestion, not supplementary information). Consider: <Tip>[Visual Data Masking](/build/agents/build-your-agent/agent-settings/visual-data-masking) can be enabled to hide sensitive information like email addresses and credit card numbers when reviewing tasks with your team.</Tip>
🏗️ Page structure (2)
  • workforce-task-view.mdx — No opening body paragraph. The page starts immediately with ## Accessing the Workforce Task View with no definition of what the Workforce Task View is. task-overview.mdx handles this correctly — its very first paragraph defines what a Task is before anything else. Add a short intro paragraph (1–2 sentences) after the frontmatter that defines the feature and who it's for.

  • workforce-task-view.mdx:36–45 and workforce-task-view.mdx:97–106### Approval management (lines 36–45) and ### Approval workflows (lines 97–106) cover almost identical ground within the same file: both walk through the steps to receive, review, and approve/reject agent actions. Consolidate into one section, or have one section link to the canonical approvals-and-escalations.mdx page instead of restating the steps.

✅ Clean files (1)

build/agents/give-your-agent-tasks/task-overview.mdx — solid page. Clear opening definition, precise UI references, good cross-linking, no banned words, no British spelling. Minor capitalization slips called out in Issues above but nothing structural.

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

Files read: build/agents/give-your-agent-tasks/task-overview.mdx (62 lines), build/workforces/workforce-features/workforce-task-view.mdx (140 lines), build/agents/give-your-agent-tasks/tasks-page.mdx (40 lines), build/workforces/workforce-features/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, 5:02 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, 5:01 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