Skip to content

docs(TSP-1358): Add documentation for 'By workforce' grouping on Tasks page#731

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

docs(TSP-1358): Add documentation for 'By workforce' grouping on Tasks page#731
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1358

Conversation

@claude

@claude claude Bot commented Jul 21, 2026

Copy link
Copy Markdown

Summary

  • tasks-page.mdx: Renamed the existing ## Tabs section to ## Status tabs for clarity, and added a new ## Grouping views section documenting the three grouping modes — All, By agent, and By workforce. Includes a note that By workforce is currently early-access (feature-flagged).
  • task-overview.mdx: Added a sentence in the "Viewing Tasks across all your Agents" section mentioning the three grouping modes available on the Tasks page.
  • workforce-task-view.mdx: Added a cross-reference to the global Tasks page's By workforce grouping in the "Monitoring Multiple Tasks" subsection, and added the Tasks page to the Related Features list.

Linear issue

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

Notes

  • The By workforce grouping is gated behind the TaskOpsByWorkforceGroupingFe PostHog flag (default off), so the note in tasks-page.mdx calls it "early-access" rather than exposing the flag name.
  • Per-agent task drill-down within a workforce is a follow-up; the current docs describe the expandable row structure as-shipped.

🤖 Generated with Claude Code

…s page

- tasks-page.mdx: Rename 'Tabs' section to 'Status tabs', add new 'Grouping
  views' section documenting All, By agent, and By workforce modes; note that
  By workforce is currently early-access
- task-overview.mdx: Mention the three grouping modes in the cross-workspace
  Tasks page paragraph
- workforce-task-view.mdx: Add cross-reference to the global Tasks page's
  By workforce grouping in the Monitoring Multiple Tasks section; add Tasks
  page to Related Features

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

linear Bot commented Jul 21, 2026

Copy link
Copy Markdown

TSP-1358

@mintlify

mintlify Bot commented Jul 21, 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 21, 2026, 7:07 AM

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

@mintlify

mintlify Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
relevanceai 🟡 Building Jul 21, 2026, 7:06 AM

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

@github-actions

Copy link
Copy Markdown
Contributor

🎯 Vibe check

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

Scores

Dimension Score What's holding it back
🔴 Consistency 5/10 workforce-task-view.mdx has 14 heading-case violations, product terms (agent, workforce, task, trigger) repeatedly lowercase, and 3 internal links using full absolute URLs instead of root-relative paths. The other two files are clean.
🟡 Technical clarity 7/10 Naming inconsistency between files: one calls the Workforce builder's task area the "Run tab", the other calls it the "Task section". Vague UI reference in workforce-task-view.mdx ("Navigate to the 'Task' section" — no exact label). Possibly unverified feature ("Export conversation logs"). Title of tasks-page.mdx ("Task Operations") doesn't match how every other file refers to it ("Tasks page").
🟢 Non-technical clarity 8/10 workforce-task-view.mdx opens with steps before defining what the feature is — minor barrier for first-time readers. The rest is clear.
🟡 Structure 7/10 workforce-task-view.mdx dives straight into access steps with no introductory definition. Procedural numbered lists throughout should be <Steps>. task-overview.mdx is missing a closing CTA for a concept page.

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

Overall vibe: task-overview.mdx and tasks-page.mdx are tight, clean, and follow the content standards well — those two files are nearly shippable as-is. workforce-task-view.mdx drags the PR down: it reads like older content that predates the formatting standards, with heading case violations on almost every heading, product terms left lowercase throughout, and absolute URLs for internal links. Fix workforce-task-view.mdx and this PR is good.

🔧 Issues (21)

Heading case — build/workforces/workforce-features/workforce-task-view.mdx

  • :14## Key Features## Key features
  • :16### Real-Time Task Monitoring### Real-time task monitoring
  • :25### Manual Trigger Activation### Manual trigger activation
  • :38### Approval Management### Approval management
  • :49### Conversation History### Conversation history
  • :62### Task Timeline### Task timeline
  • :70## Working with the Task View## Working with the task view (if "Task View" is a formal product name, keep it; otherwise lowercase)
  • :73### Monitoring Multiple Tasks### Monitoring multiple tasks
  • :83### Handling Escalations### Handling escalations
  • :95### Approval Workflows### Approval workflows
  • :104## Best Practices## Best practices
  • :106### Organizing Your Task View### Organizing your task view
  • :113### Effective Monitoring### Effective monitoring
  • :131## Related Features## Related features

Product-term capitalization — build/workforces/workforce-features/workforce-task-view.mdx

  • :42 — "the agent's work" → "the Agent's work"
  • :44 — "your workforce to operate" → "your Workforce to operate"
  • :76 — "different workforces" → "different Workforces"
  • :84,86,88,97,100 — "agents escalate", "the agent's reason", "the agent can continue", "The agent will complete", "allow the agent to proceed" → capitalize Agent throughout
  • :88 — "the task can be marked complete" → "the Task can be marked complete"
  • :107 — "your triggers and agents" → "your Triggers and Agents"
  • :112,115,116,117 — "completed tasks", "high-priority tasks", "completed tasks", "task completion times" → Tasks / Task

Internal link format — build/workforces/workforce-features/workforce-task-view.mdx

  • :132https://relevanceai.com/docs/build/agents/customise-agent/flowbuilder/build/agents/customise-agent/flowbuilder
  • :133https://relevanceai.com/docs/build/agents/customise-agent/escalate/build/agents/customise-agent/escalate
  • :134https://relevanceai.com/docs/build/agents/customise-agent/subagents/build/agents/customise-agent/subagents

Title inconsistency — build/agents/give-your-agent-tasks/tasks-page.mdx

  • :2 — Title is "Task Operations" and sidebarTitle is "Task Operations", but the page's own prose calls it "the Tasks page" (line 9), task-overview.mdx links to it as "Tasks page", and workforce-task-view.mdx references it as "the global Tasks page". Either rename to match the UI label, or update all cross-references to use "Task Operations".

Possibly unverified feature — build/workforces/workforce-features/workforce-task-view.mdx

  • :54 — "Export conversation logs for reporting or analysis" — verify this export feature exists in the product before shipping; not mentioned anywhere else in the docs.
🧩 Component suggestions (3)
  • build/workforces/workforce-features/workforce-task-view.mdx:9–12 — "Accessing the Workforce Task View" is a 2-step procedure; use <Steps> for visual progress. Same applies to the longer procedural sections: "Manual Trigger Activation" (lines 28–34, 4 steps), "Approval Management" (38–45, 4 steps), "Monitoring Multiple Tasks" (75–80, 4 steps), "Handling Escalations" (85–91, 5 steps), "Approval Workflows" (96–103, 6 steps). All of these are sequential numbered procedures and <Steps> is exactly what they're for.

  • build/agents/give-your-agent-tasks/task-overview.mdx:11–18<CardGroup> with 2 cards where the "Run tab" card has no href. CLAUDE.md says CardGroup is appropriate when items are navigable. Since the Run tab isn't its own page, consider replacing with a short prose sentence: "You can view Tasks in the Run tab of the Agent or Workforce builder, or on the Tasks page for a cross-workspace view." The Tasks page card can remain as a standalone <Card> with an href if you want to keep the visual emphasis.

  • build/workforces/workforce-features/workforce-task-view.mdx:14–69 — The "Key Features" section stacks five H3 subheadings, each with a bullet list beneath. These features don't link anywhere (no hrefs), so a <CardGroup> isn't the right fix. The content is substantial enough that the H3 prose-section approach works — but the headings currently list nouns ("Conversation History", "Task Timeline") rather than user-benefit phrases. Consider renaming them to action-oriented phrases ("View conversation history", "Track task timelines") to make skimming more useful. This is a suggestion, not a blocker.

🏗️ Page structure (2)
  • build/workforces/workforce-features/workforce-task-view.mdx — The page jumps straight into "Accessing the Workforce Task View" without a single sentence defining what the Workforce Task View is. Add a brief introductory paragraph before the first heading — something like: "The Workforce Task View is the Task tab inside each Workforce builder. It shows all Tasks for that Workforce, lets you respond to approvals and escalations, and gives you a full conversation history for each run." This orients readers who arrive via search or a direct link.

  • build/agents/give-your-agent-tasks/task-overview.mdx — No closing CTA. This is a concept page (it defines what a Task is), so a "What's next?" section is appropriate. Suggested links: Tasks page for monitoring across all Agents and Workforces, and Interact with your Agent as the natural next action after understanding Tasks.

⚠️ Contradictions (1)
  • build/agents/give-your-agent-tasks/task-overview.mdx:13 calls the task-viewing area inside the Workforce builder the "Run tab". build/workforces/workforce-features/workforce-task-view.mdx:11 instructs the reader to navigate to the "Task" section in their Workforce. If these refer to the same UI location (the task view within the Workforce builder), align the label across both files. If they're genuinely different UI elements, clarify the distinction.
✅ Clean files (1)

build/agents/give-your-agent-tasks/tasks-page.mdx — aside from the title naming issue flagged above, the content, capitalization, components, and structure are all solid.

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

Files read: task-overview.mdx (55 lines), tasks-page.mdx (54 lines), workforce-task-view.mdx (137 lines), approvals-and-escalations.mdx (145 lines), interact-with-your-agent.mdx (84 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