Skip to content

docs(TSP-1259): add escalated tasks timeline chart documentation#647

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

docs(TSP-1259): add escalated tasks timeline chart documentation#647
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1259

Conversation

@claude
Copy link
Copy Markdown

@claude claude Bot commented Jun 1, 2026

Summary

  • Adds a new Task analytics and timeline charts subsection under the Key Features section of the Workforce Task View page
  • Documents all three timeline charts: Errors, Approvals, and the new Escalated timeline chart (daily escalation counts, date range filtering, trend identification)
  • Placed after the existing "Task Timeline" section (individual task chronology) to keep the two concepts distinct

Approach

Used the comprehensive section approach — the page already had individual subsections for Errors and Approvals in the Working with the Task View area, and the new Escalated chart is a peer feature. Grouping all three charts together in one "Task analytics and timeline charts" subsection under Key Features gives users a single place to understand the aggregate monitoring capabilities, rather than scattering chart documentation across multiple sections.

Linear issue

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

Documents the new escalated tasks timeline chart on the Task View page,
alongside existing Errors and Approvals timeline charts, in a new
"Task analytics and timeline charts" section under Key Features.

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

linear Bot commented Jun 1, 2026

TSP-1259

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Jun 1, 2026

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

Project Status Preview Updated (UTC)
relevanceai 🟢 Ready View Preview Jun 1, 2026, 7:19 AM

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 1, 2026

🎯 Vibe check

Reviewed: 1 file (1 with issues, 0 clean)

Scores

Dimension Score What's holding it back
🔴 Consistency 4/10 13 heading case violations — almost every H2 and H3 on the page uses title case instead of sentence case. 3 internal links in Related Features use absolute https://relevanceai.com/docs/... URLs instead of root-relative paths.
🟡 Technical clarity 7/10 Sequential step lists throughout the page don't use <Steps>, missing visual progress cues. Navigation instruction on line 11 quotes a UI section name but doesn't say where to find it.
🟡 Non-technical clarity 7/10 The frontmatter description is clear, but the page dives straight into access instructions without an intro paragraph establishing what the Task View is and why a reader would use it.
🟡 Structure 7/10 "Approval Management" (Key Features) and "Approval Workflows" (Working with the Task View) cover overlapping ground and could confuse readers. No closing CTA — this is a feature overview page that should point readers somewhere next.

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

Overall vibe: The prose is clean and accurate, and the new analytics/timeline charts section (lines 70–84) is well-written and in correct sentence case throughout. The main drag is a systematic heading capitalization problem — virtually every H2 and H3 is in title case — plus three absolute URLs that should be root-relative. A focused capitalization pass and link fix would bring this to a solid 8+.

🔧 Issues (16)

Heading case (13 violations)

  • workforce-task-view.mdx:14## Key Features## Key features
  • workforce-task-view.mdx:16### Real-Time Task Monitoring### Real-time task monitoring
  • workforce-task-view.mdx:25### Manual Trigger Activation### Manual Trigger activation ("Trigger" stays capped as a product term; "Activation" is not)
  • 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:88### Monitoring Multiple Tasks### Monitoring multiple tasks
  • workforce-task-view.mdx:97### Handling Escalations### Handling escalations
  • workforce-task-view.mdx:107### Approval Workflows### Approval workflows
  • workforce-task-view.mdx:118## Best Practices## Best practices
  • workforce-task-view.mdx:120### Organizing Your Task View### Organizing your Task View
  • workforce-task-view.mdx:127### Effective Monitoring### Effective monitoring
  • workforce-task-view.mdx:144## Related Features## Related features

Internal links using absolute URLs (3 violations)

CLAUDE.md requires root-relative paths for internal links. These three all point to relevanceai.com/docs/...:

  • workforce-task-view.mdx:147https://relevanceai.com/docs/build/agents/customise-agent/flowbuilder → use root-relative path
  • workforce-task-view.mdx:148https://relevanceai.com/docs/build/agents/customise-agent/escalate → use root-relative path
  • workforce-task-view.mdx:149https://relevanceai.com/docs/build/agents/customise-agent/subagents → use root-relative path

Note: the fourth link on line 150 (/build/agents/build-your-agent/agent-settings/visual-data-masking) is already correct.

🧩 Component suggestions (4)
  • workforce-task-view.mdx:29–33 — "Manual Trigger Activation" uses a 4-step numbered list for a sequential procedure. Wrap in <Steps> so readers get visual progress indicators: step 1 "Locate the manual trigger", step 2 "Enter your message", etc.

  • workforce-task-view.mdx:40–44 — "Approval Management" has a 4-step numbered procedure (receive notification → review → approve/reject → provide context). Same case — <Steps> would serve better than a plain numbered list.

  • workforce-task-view.mdx:100–105 — "Handling Escalations" is a 5-step sequential procedure. Use <Steps> for consistency with other procedural sections.

  • workforce-task-view.mdx:110–116 — "Approval Workflows" is a 6-step sequential procedure. Use <Steps>. This section and "Approval Management" above cover similar ground from different angles — consider whether they can be merged into one <Steps> block under a single section.

🏗️ Page structure (2)
  • workforce-task-view.mdx — The page opens directly with "Accessing the Workforce Task View" without an introductory paragraph. The frontmatter description partially covers this, but a brief 1–2 sentence intro before the first heading would help readers orient themselves: what is the Task View, when would you use it, and what does this page cover. Concept/feature pages work best with a definition before jumping into access instructions.

  • workforce-task-view.mdx — No closing CTA. This is a feature overview page and readers finishing it likely need to either configure approvals or build a Workforce. Suggested ## What's next? linking to /build/workforces/workforce-features/approvals-and-escalations and /build/workforces/workforce-features/communication (both sibling pages) would give readers a natural next step without duplicating the Related Features list.

⚠️ Contradictions (0)

No contradictions found between the changed file and the context pages read.

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

Files read: build/workforces/workforce-features/workforce-task-view.mdx (150 lines), build/workforces/workforce-features/approvals-and-escalations.mdx (145 lines), build/workforces/workforce-features/communication.mdx (96 lines)

@jordanc-relevanceai
Copy link
Copy Markdown
Collaborator

Consolidated into #661 (Workforce Task View: bulk ops + timeline charts). Closing in favor of that PR.

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