Skip to content

docs(TSP-1441): add model usage by agent section to analytics docs - #808

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

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

Conversation

@claude

@claude claude Bot commented Sep 9, 2026

Copy link
Copy Markdown

Summary

  • Adds a new Agent model breakdown accordion to the Dashboard Sections of the analytics documentation
  • Documents the Model usage by agent expandable table (added in PR #17622), which shows per-agent LLM credit consumption within each model row
  • Covers the table's metrics (input tokens, output tokens, credits, share), interaction behavior (click to expand, click agent to navigate), filter inheritance, and API truncation note

Linear issue

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

Related

Product PR: #17622 (analytics-agent-model-breakdown-by-agent feature flag)

Documents the Model usage by agent expandable table feature (PR #17622),
which shows per-agent LLM credit consumption within the Agent Model Breakdown section.

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:03 AM

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

@linear

linear Bot commented Sep 9, 2026

Copy link
Copy Markdown

TSP-1441

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

🎯 Vibe check

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

Scores

Dimension Score What's holding it back
🔴 Consistency 5/10 Sentence case is broken in nearly every component type — headings, Step titles, Card titles, Accordion titles. Plus bold labels inside two callouts, and "agents" left lowercase when referring to the Relevance AI Agent product.
🟢 Technical clarity 9/10 Specific UI references, concrete examples (the "+45.78%" explanation, the 5 vs 3,500 credits/task comparison). No broken links — the #monitoring-concurrency-usage anchor matches the heading in plans.mdx.
🟡 Non-technical clarity 8/10 Accessible overall. The Getting Started steps and metric explanations land well. Some accordion sections bury their "How to use it" guidance under bullet lists instead of leading with it.
🟡 Structure 7/10 Accordion sections use bullet lists where CLAUDE.md requires flowing sentences. The ## Getting Started steps format is appropriate but two of the three Step titles violate sentence case.

Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5. Scores are a single overall judgment — the dropdowns below have the line-by-line specifics.

Overall vibe: The content itself is solid — practical, well-organized, and genuinely useful for someone trying to get value from the Analytics dashboard. The problem is a systematic sentence case failure that touches every component type on the page: if CLAUDE.md's style rules are enforced in CI, this file would fail on almost every section heading. Fix the title casing and strip the bold labels from the callouts and this is ready to ship.

🔧 Issues (17)

Sentence case — section headings

  • enterprise/analytics.mdx:19## Getting Started## Getting started
  • enterprise/analytics.mdx:37## Key Metrics at a Glance## Key metrics at a glance
  • enterprise/analytics.mdx:62## Dashboard Sections## Dashboard sections
  • enterprise/analytics.mdx:157## Why Use Analytics?## Why use Analytics?

Sentence case — Step titles

  • enterprise/analytics.mdx:25<Step title="Set Your Filters">"Set your filters"
  • enterprise/analytics.mdx:28<Step title="Explore Your Data">"Explore your data"

Sentence case — Card titles (Key Metrics block)

  • enterprise/analytics.mdx:45<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"

Sentence case — Accordion titles

  • enterprise/analytics.mdx:87<Accordion title="Workforce Breakdown">"Workforce breakdown" (the newly added "Agent model breakdown" at line 127 gets this right — apply same logic here)
  • enterprise/analytics.mdx:101<Accordion title="Agent Breakdown">"Agent breakdown"
  • enterprise/analytics.mdx:114<Accordion title="Action Breakdown">"Action breakdown"

Sentence case — Card titles (Why Use Analytics? block)

  • enterprise/analytics.mdx:160<Card title="Cost Control">"Cost control"
  • enterprise/analytics.mdx:164<Card title="Performance Optimization">"Performance optimization"
  • enterprise/analytics.mdx:168<Card title="Error Monitoring">"Error monitoring"
  • enterprise/analytics.mdx:172<Card title="Capacity Planning">"Capacity planning"
  • enterprise/analytics.mdx:176<Card title="ROI Visibility">"ROI visibility"

Callouts with bold labels (CLAUDE.md: "no bold labels inside")

  • enterprise/analytics.mdx:33<Tip>**Pro tip:** Scroll to the bottom... — remove the bold label; the tip reads fine without it
  • enterprise/analytics.mdx:58<Note>**Filter and Focus**: Click the date range picker... — remove the bold label or lift the label into the preceding prose as an intro sentence

Product term capitalization

  • enterprise/analytics.mdx:9 — "optimize your agents" — "agents" here refers to the Relevance AI Agent product; use "Agents". Same pattern appears at lines 42, 47, 111, 165, 172, 173, and 148 ("agent activity").
🧩 Component suggestions (2)
  • enterprise/analytics.mdx:65–84 — The "Task and Action Trends" and "Credits" accordions both use nested bullet lists under bold headers ("Quickly identify:", "How to use it:"). CLAUDE.md requires flowing sentences in accordion content, not bullet lists. Rewrite as 2–3 prose sentences: e.g. "Hover over any bar to see exact numbers for that day. If tasks are flat but credits spike, a workflow is becoming more expensive — use this to investigate and forecast monthly needs."

  • enterprise/analytics.mdx:87–125 — The "Workforce Breakdown", "Agent Breakdown", and "Action Breakdown" accordions follow the same bullet-list pattern under "How to use it:". Same fix: convert to flowing sentences. The tables in these accordions are appropriate; it's just the narrative guidance around them that needs to be prose.

🏗️ Page structure (1)
  • enterprise/analytics.mdx:127–142 — The newly added "Agent model breakdown" accordion is the only accordion in the group that correctly uses sentence case in its title and prose (no bullet lists). It sets the right standard — the other accordions should match its style.
⚠️ Contradictions (0)

No contradictions found. The concurrency chart description at line 148–153 aligns precisely with admin/subscriptions/plans.mdx:108–111. The #monitoring-concurrency-usage anchor link resolves correctly.

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

Files read: enterprise/analytics.mdx (183 lines), enterprise/quick-start-guide.mdx (459 lines — sibling), admin/subscriptions/plans.mdx (203 lines — linked page)

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