Skip to content

docs(TSP-1338): document per-project concurrency breakdown#710

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

docs(TSP-1338): document per-project concurrency breakdown#710
claude[bot] wants to merge 1 commit into
mainfrom
TSP-1338/docs-update

Conversation

@claude

@claude claude Bot commented Jul 10, 2026

Copy link
Copy Markdown

Summary

  • Expanded the Concurrency usage section in enterprise/analytics.mdx to document the new per-project breakdown feature added in PR #16034
  • Describes the new "Org total" / "By project" toggle that appears in the concurrency chart header
  • Documents the "By project" stacked bar chart view (per-project colors, tooltip showing project usage vs. org limit)
  • Notes that the toggle is visible to organization managers only

Linear issue

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

Test plan

  • Verify the updated concurrency section renders correctly in Mintlify preview
  • Confirm CardGroup icons resolve (chart-column, chart-bar)
  • Check all internal links still work

Adds documentation for the new Org total / By project toggle on the
concurrency chart, including the stacked bar view, tooltip behavior,
and org manager permission requirement.

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

linear Bot commented Jul 10, 2026

Copy link
Copy Markdown

TSP-1338

@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 4/10 Systematic title-case headings throughout (18+ violations), bold labels inside callouts, "Workforce" lowercase in two spots.
🟢 Technical clarity 9/10 Metrics well-defined, UI element names exact, edge cases called out (e.g. toggle visibility scoped to org managers).
🟢 Non-technical clarity 9/10 Clear intro, "Why use Analytics?" section makes the value concrete. No jargon drops.
🟡 Structure 7/10 Two accordions use bullet lists where CLAUDE.md requires flowing prose. "Why use Analytics?" sits after the detail sections — reads like a marketing afterthought rather than reader orientation.

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

Overall vibe: The content itself is genuinely good — specific metric definitions, practical "how to use it" guidance, and useful edge cases. The main drag is mechanical: nearly every heading and card title uses title case instead of sentence case, which is a CLAUDE.md hard requirement. Fix the capitalization sweep and the two callout labels, and this page is in solid shape.

🔧 Issues (22)

Heading sentence case

  • enterprise/analytics.mdx:19## Getting Started## Getting started
  • 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:46<Card title="Tasks to Review"> → "Tasks to review"
  • enterprise/analytics.mdx:48<Card title="Actions Used"> → "Actions used"
  • enterprise/analytics.mdx:51<Card title="Credits Used"> → "Credits used"
  • enterprise/analytics.mdx:62## Dashboard Sections## Dashboard sections
  • enterprise/analytics.mdx:65<Accordion title="Task and Action Trends"> → "Task and action trends"
  • enterprise/analytics.mdx:87<Accordion title="Workforce Breakdown"> → "Workforce breakdown"
  • enterprise/analytics.mdx:101<Accordion title="Agent Breakdown"> → "Agent breakdown"
  • enterprise/analytics.mdx:114<Accordion title="Action Breakdown"> → "Action breakdown"
  • enterprise/analytics.mdx:155## Why Use Analytics?## Why use Analytics?
  • enterprise/analytics.mdx:158<Card title="Cost Control"> → "Cost control"
  • enterprise/analytics.mdx:163<Card title="Performance Optimization"> → "Performance optimization"
  • enterprise/analytics.mdx:166<Card title="Error Monitoring"> → "Error monitoring"
  • enterprise/analytics.mdx:170<Card title="Capacity Planning"> → "Capacity planning"
  • enterprise/analytics.mdx:174<Card title="ROI Visibility"> → "ROI visibility" (ROI stays all-caps as an acronym)

Callout bold labels

  • enterprise/analytics.mdx:33<Tip>**Pro tip:** uses a bold label inside a callout. CLAUDE.md: "no bold labels inside." Drop the label and start with the actual guidance: "Scroll to the bottom of any breakdown table to see summary stats…"
  • enterprise/analytics.mdx:58<Note>**Filter and Focus**: same issue. Rewrite as a plain sentence: "Use the date range picker (top right) to select custom periods, and the "All agents" dropdown to filter by individual agent…"

Product term capitalization

  • enterprise/analytics.mdx:4 — description field: "AI workforce performance" → "AI Workforce performance" (Workforce is a Relevance AI product term)
  • enterprise/analytics.mdx:9 — "how your AI workforce is performing" → "your AI Workforce"
🧩 Component suggestions (1)
  • enterprise/analytics.mdx:65–84 — The "Task and Action Trends" and "Credits" accordions use a **Quickly identify:** bold header followed by a bullet list. CLAUDE.md: "Accordion content: use flowing sentences, not bullet lists." Convert to two or three short sentences. Example for Credits: "Hover over bars to see exact daily amounts. If tasks are flat but credits spike, you have a workflow becoming more expensive — investigate agents with high Actions/Task ratios. Use historical patterns to estimate monthly credit needs."
🏗️ Page structure (1)
  • enterprise/analytics.mdx — "Why use Analytics?" (line 155) sits after all the detailed how-to sections. Readers who need to be convinced of value will hit a wall of metrics and breakdowns before they reach the rationale. Consider moving this section to just after the intro frame (before "Getting started"), or fold the most compelling points into the intro paragraph.
🔋 Credit usage
Item Count
Files reviewed 1
Context pages read 2
Total lines processed ~680

Files read: enterprise/analytics.mdx (181 lines), enterprise/quick-start-guide.mdx (459 lines), admin/subscriptions/plans.mdx (~40 lines, offset 95–134)

@mintlify

mintlify Bot commented Jul 10, 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 10, 2026, 5:05 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