Skip to content

docs(TSP-1443): add cost visibility to TaskOps task lists and sidebar - #819

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

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

Conversation

@claude

@claude claude Bot commented Sep 15, 2026

Copy link
Copy Markdown

Summary

Amends PR #800 / TSP-1427 with additional cost-visibility surfaces added in relevance-api-node PR #17784 (PGTM-519).

  • Per-task Credits and Actions columns in agent and workforce task list tables (distinct from the aggregate Analytics breakdown tables documented in PR docs(TSP-1427): add eval metrics to analytics breakdown tables #800)
  • MonitorTaskCostEnrichment feature flag callout — columns are off by default and rolling out via PostHog
  • TaskCostBreakdownModal from individual task rows — documents the modal triggered from a task list row Credits value, showing total credits/actions with a by-source split (task run vs eval costs) and collapsible detail sections
  • Sidebar Credits/Actions chips — chips now include evaluation costs; tooltip explains the breakdown; clicking Credits opens the TaskCostBreakdownModal
  • Backend deployment dependency — the frontend sends a statuses field that older nodeapi backends reject with a 400 error; note added for self-hosted/enterprise deployments

Files changed

  • build/agents/give-your-agent-tasks/tasks-page.mdx — new "Cost visibility in task lists" section with feature flag callout, modal docs, and backend deployment warning
  • build/agents/give-your-agent-tasks/task-overview.mdx — updated Details section to document Credits/Actions chips and modal in the task sidebar
  • build/workforces/workforce-features/workforce-task-view.mdx — added Credits/Actions columns and modal entry point for workforce task lists

Test plan

  • Verify headings are sentence case
  • Verify all internal links resolve (/enterprise/analytics, /build/agents/give-your-agent-tasks/task-overview#details)
  • Confirm callout components use valid types (<Info>, <Warning>, <Note>)
  • Confirm no content duplicated from PR docs(TSP-1427): add eval metrics to analytics breakdown tables #800 analytics context

Linear issue: https://linear.app/relevance/issue/TSP-1443/
Amends: #800

…debar

Amends PR #800 (TSP-1427) with the task-list and sidebar cost surfaces
added in relevance-api-node PR #17784 (PGTM-519):

- Credits and Actions columns on individual task list rows (agent and
  workforce), gated behind MonitorTaskCostEnrichment feature flag
- TaskCostBreakdownModal accessible from task list row Credits values
  and the sidebar Credits chip; shows by-source split of task run vs
  eval costs with collapsible detail sections
- Sidebar Credits/Actions chips now include evaluation costs; hover
  tooltip explains the breakdown
- Backend deployment dependency note: frontend statuses field requires
  updated nodeapi backend or older backends return 400

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

mintlify Bot commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
relevanceai 🟢 Ready View Preview Sep 15, 2026, 3:05 AM

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

@linear

linear Bot commented Sep 15, 2026

Copy link
Copy Markdown

TSP-1443

@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 13 heading capitalization errors across every section and subsection. Internal links in that file use absolute URLs (https://relevanceai.com/docs/...) instead of root-relative paths as required.
🟡 Technical clarity 7/10 Internal feature flag name (MonitorTaskCostEnrichment) and PostHog details exposed to end users in both files. The <Warning> callout in tasks-page.mdx has a bold label inside it (against CLAUDE.md rules). workforce-task-view.mdx uses "Task" in quotes instead of bold for a UI element name.
🟡 Non-technical clarity 7/10 task-overview.mdx and tasks-page.mdx are clear. workforce-task-view.mdx is wordy and mixes overview with reference material without being precise about what actions to take. The feature flag details in Info boxes give end users information they can't act on.
🟡 Structure 6/10 workforce-task-view.mdx uses plain numbered lists for sequential procedures that should use <Steps>. One numbered list in that file describes characteristics (not sequence) and should be bullets. The deployment <Warning> in tasks-page.mdx is buried at the end of a user-facing page, addressed at ops/admins.

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

Overall vibe: The cost visibility additions to task-overview.mdx and tasks-page.mdx are well-executed — precise UI element names, correct cross-references, and consistent descriptions. workforce-task-view.mdx is the problem: it reads like a pre-existing page that wasn't brought up to the project's style standards before this PR landed, with heading capitalization errors on nearly every heading and a structure that doesn't use the available Mintlify components.

🔧 Issues (14)
  • build/workforces/workforce-features/workforce-task-view.mdx:14## Key Features → sentence case: ## Key features
  • build/workforces/workforce-features/workforce-task-view.mdx:16### Real-Time Task Monitoring → sentence case: ### Real-time task monitoring
  • build/workforces/workforce-features/workforce-task-view.mdx:33### Manual Trigger Activation → sentence case: ### Manual trigger activation
  • build/workforces/workforce-features/workforce-task-view.mdx:44### Approval Management → sentence case: ### Approval management
  • build/workforces/workforce-features/workforce-task-view.mdx:55### Conversation History → sentence case: ### Conversation history
  • build/workforces/workforce-features/workforce-task-view.mdx:69### Task Timeline → sentence case: ### Task timeline
  • build/workforces/workforce-features/workforce-task-view.mdx:80### Monitoring Multiple Tasks → sentence case: ### Monitoring multiple tasks
  • build/workforces/workforce-features/workforce-task-view.mdx:89### Handling Escalations → sentence case: ### Handling escalations
  • build/workforces/workforce-features/workforce-task-view.mdx:99### Approval Workflows → sentence case: ### Approval workflows
  • build/workforces/workforce-features/workforce-task-view.mdx:110## Best Practices → sentence case: ## Best practices
  • build/workforces/workforce-features/workforce-task-view.mdx:113### Organizing Your Task View### Organizing your Task View
  • build/workforces/workforce-features/workforce-task-view.mdx:119### Effective Monitoring → sentence case: ### Effective monitoring
  • build/workforces/workforce-features/workforce-task-view.mdx:136## Related Features → sentence case: ## Related features
  • build/workforces/workforce-features/workforce-task-view.mdx:138–140 — Internal links use absolute URLs (https://relevanceai.com/docs/build/agents/customise-agent/flowbuilder, etc.) instead of root-relative paths (/build/agents/customise-agent/flowbuilder). CLAUDE.md requires root-relative for internal links.
🧩 Component suggestions (6)
  • build/agents/give-your-agent-tasks/tasks-page.mdx:67–69<Warning> opens with a bold label (**Deployment dependency for self-hosted and enterprise installations**). CLAUDE.md says callouts must be a single short paragraph with no bold labels inside. Promote the label to a heading before the callout: ### Deployment dependency for self-hosted installations, then a <Warning> containing just the plain-text sentence.

  • build/workforces/workforce-features/workforce-task-view.mdx:35–39 — The four-item numbered list under ### Manual trigger activation describes a sequential user procedure. Replace with a <Steps> component so each action gets a visual progress indicator.

  • build/workforces/workforce-features/workforce-task-view.mdx:47–51 — Same pattern: four-step approval procedure. Replace with <Steps>.

  • build/workforces/workforce-features/workforce-task-view.mdx:82–87 — Numbered list under ### Monitoring multiple tasks describes interface characteristics, not an ordered procedure ("Tasks are organized chronologically...", "Expand individual tasks..."). These imply no sequence — convert to a bullet list.

  • build/workforces/workforce-features/workforce-task-view.mdx:90–97 — Five-step escalation-handling procedure. Replace with <Steps>.

  • build/workforces/workforce-features/workforce-task-view.mdx:100–109 — Six-step approval workflow procedure. Replace with <Steps>.

🏗️ Page structure (3)
  • build/agents/give-your-agent-tasks/tasks-page.mdx:45–47 and build/workforces/workforce-features/workforce-task-view.mdx:27–29 — Both <Info> boxes name the internal MonitorTaskCostEnrichment feature flag and PostHog. The tasks-page.mdx version adds "Contact your account manager if you need early access"; the workforce version omits this. End users can't act on a feature flag name — either remove the flag name entirely and keep only "may not be visible on all accounts immediately, contact your account manager for early access," or align both Info boxes so the guidance is consistent.

  • build/agents/give-your-agent-tasks/tasks-page.mdx:67–69 — The <Warning> about backend deployment compatibility for self-hosted installations is the last thing on the page. It's addressed at ops/admins, not the end users who just read about task cost visibility. Consider moving it to a dedicated self-hosted release notes or deployment doc, or at minimum add a short audience qualifier so end users know to skip it.

  • build/workforces/workforce-features/workforce-task-view.mdx — No closing CTA. This is a concept+how-to hybrid page; a reader who has just learned how to use the Workforce Task View has no obvious next step. Add a ## What's next linking to the Agents-side equivalent (Tasks) and to the approvals setup guide (Approvals and escalations).

✅ Clean files (1)

build/agents/give-your-agent-tasks/task-overview.mdx

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

Files read: task-overview.mdx (65 lines), tasks-page.mdx (70 lines), workforce-task-view.mdx (142 lines), interact-with-your-agent.mdx (84 lines), approvals-and-escalations.mdx (145 lines), analytics.mdx (60 lines, partial)

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