Skip to content

Add To Review Timeline Chart documentation to Workforce Task View#630

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

Add To Review Timeline Chart documentation to Workforce Task View#630
claude[bot] wants to merge 1 commit into
mainfrom
TSP-1244/docs-update

Conversation

@claude
Copy link
Copy Markdown

@claude claude Bot commented May 19, 2026

Summary

  • Adds a new To Review Timeline Chart subsection under Key Features in build/workforces/workforce-features/workforce-task-view.mdx
  • Section is positioned after the existing Task Timeline subsection
  • Documents the 7-day bar chart that shows daily counts of tasks requiring review

Changes

The new section includes:

  • Overview of the chart's purpose (identifying review bottlenecks and approval workflow patterns)
  • "Quickly identify" bullet list for common use patterns
  • "How to use it" instructions (hover tooltips, click-to-filter, filter synchronization, empty state behavior)
  • Use cases paragraph with cross-links to the Approval Management and Monitoring Multiple Tasks sections
  • <Info> callout noting the TaskOpsMilestone2Fe feature flag requirement

Linear issue

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

🤖 Generated with Claude Code

…k View

Adds a new Key Features subsection documenting the To Review Timeline Chart,
a 7-day bar chart showing daily counts of tasks requiring review. Includes
overview, quick-identify bullets, how-to-use steps, use cases, and a feature
flag note for TaskOpsMilestone2Fe.

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

linear Bot commented May 19, 2026

TSP-1244

@github-actions
Copy link
Copy Markdown
Contributor

🎯 Vibe check

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

Scores

Dimension Score What's holding it back
🔴 Consistency 3/10 14 heading sentence case violations across the file; 3 absolute URLs in Related Features that should be root-relative paths per CLAUDE.md
🟡 Technical clarity 7/10 Feature flag visibility note is helpful; anchor links are valid; UI element names use straight quotes instead of bold in one spot; absolute URLs in Related Features are harder to maintain
🟢 Non-technical clarity 9/10 Clear purpose, well-explained sections, logical flow. The new chart section explains what it does and how to use it without jargon.
🟡 Structure 6/10 The new "To Review Timeline Chart" section uses bold text as pseudo-subheadings before bullet lists — CLAUDE.md says to use proper headings instead

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

Overall vibe: The new "To Review Timeline Chart" section adds genuinely useful content — the feature flag note, tooltip behavior, and filter interaction are exactly the kind of non-obvious details docs should capture. However, the file has pervasive sentence case violations across nearly every heading, and the new section introduces bold-text pseudo-subheadings that should be #### headings. Fix the capitalization and the structural issue in the new section and this will be solid.

🔧 Issues (18)

Heading sentence case violations — CLAUDE.md requires sentence case on all headings; only proper nouns and product names get capitals:

  • 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" is the product feature name and stays capitalized)
  • workforce-task-view.mdx:36### Approval Management### Approval management
  • workforce-task-view.mdx:47### Conversation History### Conversation history
  • workforce-task-view.mdx:60### Task Timeline### Task timeline
  • workforce-task-view.mdx:70### To Review Timeline Chart### To review timeline chart (unless "To Review Timeline Chart" is a fixed UI label — if it is, treat it as a proper noun and keep caps)
  • workforce-task-view.mdx:92### Monitoring Multiple Tasks### Monitoring multiple tasks
  • workforce-task-view.mdx:101### Handling Escalations### Handling escalations
  • workforce-task-view.mdx:113### Approval Workflows### Approval workflows
  • workforce-task-view.mdx:123## Best Practices## Best practices
  • workforce-task-view.mdx:124### Organizing Your Task View### Organizing your Task View ("Task View" stays as product feature name)
  • workforce-task-view.mdx:131### Effective Monitoring### Effective monitoring
  • workforce-task-view.mdx:148## Related Features## Related features

Absolute URLs instead of root-relative paths — CLAUDE.md says to use root-relative paths for internal links:

  • workforce-task-view.mdx:150https://relevanceai.com/docs/build/agents/customise-agent/flowbuilder/build/agents/customise-agent/flowbuilder
  • workforce-task-view.mdx:151https://relevanceai.com/docs/build/agents/customise-agent/escalate/build/agents/customise-agent/escalate
  • workforce-task-view.mdx:152https://relevanceai.com/docs/build/agents/customise-agent/subagents/build/agents/customise-agent/subagents

UI element name formatting:

  • workforce-task-view.mdx:11"Task" uses straight quotes for a UI element name; should use bold: **Task** (consistent with how other docs reference exact UI labels)
🧩 Component suggestions (3)
  • workforce-task-view.mdx:74**Quickly identify:** is bold text acting as a section subheading before a bullet list. CLAUDE.md says not to mix bold with heading formats — use a proper heading instead: #### Quickly identify
  • workforce-task-view.mdx:80 — Same issue: **How to use it:**#### How to use it
  • workforce-task-view.mdx:86**Use cases:** followed by prose → #### Use cases. This one is a run-on sentence rather than a list, which is fine, but the bold pseudo-header pattern is still inconsistent with CLAUDE.md.
⚠️ Contradictions (0)

No contradictions found between the changed file and sibling pages. The approvals-and-escalations.mdx sibling describes the same approval management concepts consistently with how this page describes them.

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

Files read: workforce-task-view.mdx (154 lines), approvals-and-escalations.mdx (145 lines), communication.mdx (96 lines — partial context), directory listing (8 items)

@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