Skip to content

Update Concurrency Usage chart documentation (TSP-1349)#725

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

Update Concurrency Usage chart documentation (TSP-1349)#725
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1349

Conversation

@claude

@claude claude Bot commented Jul 15, 2026

Copy link
Copy Markdown

Summary

Documents the updated Concurrency Usage chart behavior introduced in PR #16148.

  • enterprise/analytics.mdx — Expanded the "Concurrency usage" section from 2 sentences to a comprehensive description: stacked bar chart format, Running (blue) and Queued (red) bands, explanation of when queued tasks appear, per-project breakdown, hover tooltip layout, and a link to System Quotas for per-tier limits.
  • admin/subscriptions/plans.mdx — Corrected "time-series area chart" to "stacked bar chart" and added descriptions of the two bands, per-project breakdown, and tooltip behavior to match the analytics page.

Both pages now consistently describe the chart format and behavior.

Closes Linear issue: https://linear.app/relevance/issue/TSP-1349/
Related product PR: #16148

Expands the concurrency usage section in analytics.mdx and corrects the
description in plans.mdx to reflect the stacked bar chart with Running
(blue) and Queued (red) bands introduced in PR #16148.

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

linear Bot commented Jul 15, 2026

Copy link
Copy Markdown

TSP-1349

@github-actions

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 heading case violations across every heading level — main headings, step titles, accordion titles, and all 5 card titles. admin/subscriptions/plans.mdx uses the British spelling "Cancelling".
🟡 Technical clarity 8/10 enterprise/analytics.mdx uses "Credits Used" as a metric name while the linked plans.mdx page uses "Vendor Credits" — a reader who just read about Vendor Credits will be confused when they don't find that term in the analytics dashboard docs.
🟡 Non-technical clarity 7/10 enterprise/analytics.mdx buries the "Why use Analytics?" value proposition at the bottom, after five detailed technical sections. Non-technical stakeholders (the most likely audience for that section) have to read past all the feature mechanics before getting the business case.
🟡 Structure 6/10 enterprise/analytics.mdx structure is inverted (how-to → features → why), missing a closing CTA. Component choices are otherwise sensible.

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

Overall vibe: plans.mdx is well-written and nearly clean — one spelling slip and two over-weighted callouts are easy fixes. analytics.mdx has solid content and good use of accordions and tables, but heading-case violations are pervasive (every heading, step title, accordion title, and card title is in title case instead of sentence case) and the page structure puts the value-prop content last.

🔧 Issues (17)
  • enterprise/analytics.mdx:19## Getting Started## Getting started (sentence case)
  • enterprise/analytics.mdx:25<Step title="Set Your Filters">Set your filters
  • enterprise/analytics.mdx:28<Step title="Explore Your Data">Explore your data
  • enterprise/analytics.mdx:37## Key Metrics at a Glance## Key metrics at a glance
  • enterprise/analytics.mdx:63## Dashboard Sections## Dashboard sections
  • enterprise/analytics.mdx:65 — Accordion title Task and Action TrendsTask and Action trends ("Action" stays capped as a product term)
  • enterprise/analytics.mdx:87 — Accordion title Workforce BreakdownWorkforce breakdown
  • enterprise/analytics.mdx:101 — Accordion title Agent BreakdownAgent breakdown
  • enterprise/analytics.mdx:114 — Accordion title Action BreakdownAction breakdown
  • enterprise/analytics.mdx:149## Why Use Analytics?## Why use Analytics? ("Analytics" stays capped as the product feature name)
  • enterprise/analytics.mdx:152 — Card title Cost ControlCost control
  • enterprise/analytics.mdx:156 — Card title Performance OptimizationPerformance optimization
  • enterprise/analytics.mdx:160 — Card title Error MonitoringError monitoring
  • enterprise/analytics.mdx:164 — Card title Capacity PlanningCapacity planning
  • enterprise/analytics.mdx:168 — Card title ROI VisibilityROI visibility
  • admin/subscriptions/plans.mdx:150 — "Cancelling" → "Canceling" (American English; double-L is British)
  • enterprise/analytics.mdx:4 — Description says "in real-time" but the dashboard shows time-series charts of historical data, not a live feed. If the data does update in real time, verify and clarify; if not, remove "in real-time".
🧩 Component suggestions (4)
  • enterprise/analytics.mdx:33<Tip> opens with **Pro tip:** in bold. CLAUDE.md says callouts must be one short paragraph with no bold labels inside — the callout type already communicates it's a tip. Remove the **Pro tip:** prefix; the sentence reads fine without it.
  • enterprise/analytics.mdx:58<Note> opens with **Filter and Focus**: in bold. Same issue — bold label inside a callout is against style. If you want a label, promote this to a proper ### Filtering and focusing your view heading above the note, or just drop the bold prefix and let the text stand alone.
  • admin/subscriptions/plans.mdx:66<Warning> for "You'll only have access to this section if you are an admin of your Organization." An access-control prerequisite is informational, not a risk or irreversible action. Swap to <Note>.
  • admin/subscriptions/plans.mdx:172 — Same pattern: <Warning> for "You'll only have access to Invoice management if you are an admin" → <Note>.
🏗️ Page structure (2)
  • enterprise/analytics.mdx — "Why use Analytics?" is the last section on the page, after Getting Started, Key Metrics, Dashboard Sections, and Concurrency Usage. This puts the value proposition behind a wall of feature mechanics. Move it to just after the intro paragraph (before Getting Started), or fold the key points into the intro. Stakeholders reading to understand whether to use the feature need to see the case for it before a five-section deep-dive.
  • enterprise/analytics.mdx — No closing CTA. This is a feature concept/overview page; readers who've finished it need somewhere to go. Suggest ending with a short ## What's next? or a <CardGroup> pointing to /admin/subscriptions/plans (understand cost and credit tracking) and /admin/system-limits (understand concurrency limits that affect the chart they just read about).
⚠️ Contradictions (1)
  • enterprise/analytics.mdx:48–53 shows two separate metrics — "Actions Used" and "Credits Used". admin/subscriptions/plans.mdx throughout calls the two billing dimensions "Actions" and "Vendor Credits". A reader coming from plans.mdx will look for "Vendor Credits" in the analytics dashboard and find "Credits" instead. If "Credits Used" in the dashboard UI literally means "Vendor Credits", call that out explicitly — e.g., "Credits Used (Vendor Credits consumed across all activities)". If the UI label has been updated, update the analytics page to match.
🔋 Credit usage
Item Count
Files reviewed 2
Context pages read 2
Total lines processed ~390

Files read: admin/subscriptions/plans.mdx (210 lines), enterprise/analytics.mdx (175 lines), admin/subscriptions/new-pricing.mdx (194 lines), admin/system-limits.mdx (49 lines)

@mintlify

mintlify Bot commented Jul 15, 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 15, 2026, 4:52 AM

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

@mintlify

mintlify Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
relevanceai 🟡 Building Jul 15, 2026, 4:50 AM

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

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