Skip to content

docs(TSP-1442): document the Show queued toggle on the concurrency chart - #807

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

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

Conversation

@claude

@claude claude Bot commented Sep 9, 2026

Copy link
Copy Markdown

Summary

  • Documents the new Show queued toggle on the concurrency usage chart in Organization analytics
  • Updated enterprise/analytics.mdx (Analytics page) and admin/subscriptions/plans.mdx (Plans and credits page) to describe the toggle, its behavior, and when it appears

Changes

The concurrency chart now has a "Show queued" toggle that appears when queued task data exists in the selected time range. Both pages that reference the concurrency chart have been updated to explain:

  • The toggle appears only when there is queued task data in the selected time range
  • Hiding queued bars rescales the y-axis for better visibility of running concurrency
  • Bars with hidden queued work show a tooltip footnote (e.g., "+4,000 queued (hidden)")
  • The toggle preference persists across page reloads
  • Queued tasks are shown by default

Linear issue

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

🤖 Generated with Claude Code

Add documentation for the new Show queued toggle that appears on the
concurrency usage chart when queued task data exists in the selected
time range. Explains the y-axis rescaling behavior, tooltip footnotes
for hidden queued work, and that the preference persists across reloads.

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

mintlify Bot commented Sep 9, 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 9, 2026, 7:02 AM

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

@linear

linear Bot commented Sep 9, 2026

Copy link
Copy Markdown

TSP-1442

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 2 files (2 with issues, 0 clean)

Scores

Dimension Score What's holding it back
🔴 Consistency 3/10 enterprise/analytics.mdx has 18 sentence case violations across headings, Step titles, Card titles, and Accordion titles. Plans.mdx has one British spelling.
🟡 Technical clarity 7/10 One awkward step description in plans.mdx:82. Both pages otherwise give precise UI element names and useful behavioral detail.
🟢 Non-technical clarity 8/10 Both pages explain their content before diving into steps. The "How to use it" prompts inside analytics.mdx accordions are genuinely helpful.
🟢 Structure 8/10 Component choices are appropriate throughout — accordions for optional depth, CardGroups for parallel features, Steps for sequential procedures. No structural missteps.

Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5. Scores are a single overall judgment about the whole PR — not per file. The dropdowns below contain the line-by-line specifics.

Overall vibe: The plans.mdx content is solid and well-organized — the new concurrency section is clear and the rollover distinctions are explained cleanly. The analytics.mdx content is also genuinely useful, but it was written in title case throughout and needs a mechanical pass to fix capitalization on nearly every heading, Step title, Card title, and Accordion title before it can ship.

🔧 Issues (20)

enterprise/analytics.mdx — sentence case violations (18)

  • enterprise/analytics.mdx:19## Getting Started## Getting started
  • enterprise/analytics.mdx:25Step title="Set Your Filters""Set your filters"
  • enterprise/analytics.mdx:29Step title="Explore Your Data""Explore your data"
  • enterprise/analytics.mdx:37## Key Metrics at a Glance## Key metrics at a glance
  • enterprise/analytics.mdx:45Card title="Tasks to Review""Tasks to review"
  • enterprise/analytics.mdx:48Card title="Actions Used""Actions used"
  • enterprise/analytics.mdx:51Card title="Credits Used""Credits used"
  • enterprise/analytics.mdx:63## Dashboard Sections## Dashboard sections
  • enterprise/analytics.mdx:65Accordion title="Task and Action Trends""Task and action trends"
  • enterprise/analytics.mdx:87Accordion title="Workforce Breakdown""Workforce breakdown"
  • enterprise/analytics.mdx:101Accordion title="Agent Breakdown""Agent breakdown"
  • enterprise/analytics.mdx:114Accordion title="Action Breakdown""Action breakdown"
  • enterprise/analytics.mdx:142## Why Use Analytics?## Why use Analytics?
  • enterprise/analytics.mdx:145Card title="Cost Control""Cost control"
  • enterprise/analytics.mdx:149Card title="Performance Optimization""Performance optimization"
  • enterprise/analytics.mdx:153Card title="Error Monitoring""Error monitoring"
  • enterprise/analytics.mdx:157Card title="Capacity Planning""Capacity planning"
  • enterprise/analytics.mdx:161Card title="ROI Visibility""ROI visibility" (ROI stays all-caps as an acronym; "Visibility" becomes lowercase)

admin/subscriptions/plans.mdx — spelling and clarity (2)

  • admin/subscriptions/plans.mdx:145## Cancelling your subscription## Canceling your subscription (American English; double-l is British)
  • admin/subscriptions/plans.mdx:82 — "First, access the run of your Agent you want to view credits on, on the Run screen" — repeated "on, on" is awkward. Suggested rewrite: "Open the run of your Agent whose credits you want to view, on the Run screen."
🧩 Component suggestions (2)
  • enterprise/analytics.mdx:33<Tip>**Pro tip:** Scroll to the bottom... — CLAUDE.md bars bold labels inside callouts. Drop the **Pro tip:** label and start directly with the instruction: <Tip>Scroll to the bottom of any breakdown table to see summary stats like "Avg: 0.36% error rate" and "Avg: 95 credits/task" — these give instant performance benchmarks without reviewing individual rows.</Tip>
  • enterprise/analytics.mdx:58<Note>**Filter and Focus**: Click the date range picker... — same rule. Remove the bold label. The note is readable without it: <Note>Click the date range picker (top right) to select custom time periods. Use the "All agents" dropdown to view individual agent performance, or select a specific agent to scope all charts and tables to that agent.</Note>
⚠️ Contradictions (1)
  • enterprise/analytics.mdx:51 has a "Credits Used" card that describes "Total Relevance AI credits consumed across all activities." admin/subscriptions/plans.mdx consistently separates Actions and Vendor Credits as distinct billing units throughout. If the Analytics UI actually shows a combined "Credits" metric (rather than separate Actions and Vendor Credits rows), this is fine — but if it now reflects the split, the card title and description need to be updated to match the Plans page terminology.
🔋 Credit usage
Item Count
Files reviewed 2
Context pages read 3 (spend-controls.mdx, new-pricing.mdx, quick-start-guide.mdx)
Anchor verified 1 (/admin/system-limits#concurrent-tasks — heading confirmed at system-limits.mdx:28)
Total lines processed ~530

Files read: admin/subscriptions/plans.mdx (205 lines), enterprise/analytics.mdx (168 lines), admin/subscriptions/spend-controls.mdx (69 lines), admin/subscriptions/new-pricing.mdx (60 lines, partial), enterprise/quick-start-guide.mdx (50 lines, partial), admin/system-limits.mdx (grep only)

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