Skip to content

docs(TSP-1285): add agent-level concurrency monitoring documentation#672

Open
claude[bot] wants to merge 5 commits into
mainfrom
docs/TSP-1285
Open

docs(TSP-1285): add agent-level concurrency monitoring documentation#672
claude[bot] wants to merge 5 commits into
mainfrom
docs/TSP-1285

Conversation

@claude

@claude claude Bot commented Jun 11, 2026

Copy link
Copy Markdown

Summary

  • Restructures the "Monitoring concurrency usage" section in admin/subscriptions/plans.mdx into two subsections: "At an organization level" (existing content) and "At an individual agent level" (new).
  • The new per-agent subsection explains that each agent's analytics page shows the same org-wide concurrency chart, and guides users through navigating to it.
  • The same restructuring is applied identically to both the new billing (Actions & Vendor Credits) tab and the old billing (Credits) tab.
  • Adds a brief "Agent-level concurrency monitoring" section to enterprise/analytics.mdx with a cross-reference to the Plans and Credits page.

Test plan

  • Both billing tabs in plans.mdx render the new subsections correctly
  • Anchor link /admin/subscriptions/plans#monitoring-concurrency-usage resolves to the correct heading
  • Cross-reference link in analytics.mdx resolves correctly
  • All headings follow sentence case
  • No banned words introduced

Relates to: https://linear.app/relevance/issue/TSP-1285/
Implements: PR #15462

🤖 Generated with Claude Code

Restructures the "Monitoring concurrency usage" section in plans.mdx to
split org-level and per-agent instructions into subsections. Adds a new
"At an individual agent level" subsection explaining that each agent's
analytics page now shows the same org-wide concurrency chart, helping
users correlate specific agent activity with overall concurrency patterns.

Applies the same restructuring to both the new billing and old billing tabs.

Also adds a brief "Agent-level concurrency monitoring" section to the
enterprise analytics page with a cross-reference back to Plans and Credits.

Relates to PR #15462.

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

linear Bot commented Jun 11, 2026

Copy link
Copy Markdown

TSP-1285

@mintlify

mintlify Bot commented Jun 11, 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 Jun 11, 2026, 3:27 AM

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

@jordanc-relevanceai jordanc-relevanceai self-assigned this Jun 11, 2026
@github-actions

This comment was marked as outdated.

The org-level and agent-level concurrency charts show identical
organization-wide data, so the "At an organization level" /
"At an individual agent level" split implied a difference that
does not exist. Collapse both subsections into one explanation
with two access paths to the same chart.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The chart on the Analytics page shows organization-wide data, not
agent-specific data. Rename the heading to "Concurrency usage", state
the data scope explicitly, and refer to it as the Analytics page rather
than "each agent".

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Refer to the Analytics page directly instead of "any agent's" /
"that agent's", matching the org-wide framing of the chart.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The Analytics page is its own page, not only reachable via an agent's
tab. Drop the "open an agent, then click Analytics" navigation from
both billing tabs and remove the equivalent line in analytics.mdx.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@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 6/10 analytics.mdx has 6 heading capitalisation violations (all sentence-case failures); both callouts in analytics.mdx have banned bold labels inside them; plans.mdx uses British-variant "Cancelling" twice.
🟢 Technical clarity 9/10 Both pages explain UI steps precisely. The <Note> on analytics.mdx:58 packs three sentences into a single callout, which stretches "single short paragraph."
🟡 Non-technical clarity 8/10 analytics.mdx:9 intro sentence ends with a marketing-style em-dash flourish ("—all from a single dashboard") that adds fluff without substance. Plans page is accessible throughout.
🟡 Structure 7/10 analytics.mdx puts a "Getting Started" navigation block before the reader knows what any of the metrics mean; the page would read more naturally if the key-metrics overview came first. The "Why Use Analytics?" section at the end is effectively a duplicate of the intro, adding length without new information.

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

Overall vibe: plans.mdx is solid — clear, well-structured, and technically precise. analytics.mdx needs a capitalisation pass (six headings/step titles in title case) and two callout fixes before it ships; the content itself is genuinely useful but the standards violations are numerous enough to feel unpolished.

🔧 Issues (10)
  • enterprise/analytics.mdx:19 — heading "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:33<Tip> opens with bold label **Pro tip:** — CLAUDE.md prohibits bold labels inside callouts; remove the label and start with the tip text directly
  • enterprise/analytics.mdx:37 — heading "Key Metrics at a Glance" → "Key metrics at a glance"
  • enterprise/analytics.mdx:58<Note> opens with bold label **Filter and Focus**: — same rule; remove the label. Also three full sentences is pushing past "single short paragraph" — consider trimming or moving the comparison example to inline prose
  • enterprise/analytics.mdx:63 — heading "Dashboard Sections" → "Dashboard sections"
  • enterprise/analytics.mdx:140 — heading "Why Use Analytics?" → "Why use Analytics?" (Analytics is a proper product name; "Use" is not)
  • admin/subscriptions/plans.mdx:155 — heading ## Cancelling your subscription → "Canceling" (American English; single-l is the US-preferred spelling per Merriam-Webster)
  • admin/subscriptions/plans.mdx:351 — same heading in the Old billing tab: "Cancelling" → "Canceling"
🏗️ Page structure (2)
  • enterprise/analytics.mdx — "Getting started" <Steps> block (lines 21–31) comes before any explanation of what the metrics mean. A reader landing here for the first time has to navigate to a dashboard they don't yet understand. Move the key-metrics <CardGroup> (currently line 41) to the top, then follow with the getting-started steps.
  • enterprise/analytics.mdx:140–166 — "Why use Analytics?" repeats points already made in the intro paragraph (cost control, error monitoring, capacity planning). Either cut this section or replace it with a closing CTA pointing to related pages — e.g. Plans and credits and System Quotas — rather than re-summarising the page.
✅ Clean files (0)

Both files had issues; none were fully clean.

🔋 Credit usage
Item Count
Files reviewed 2
Context pages read 2 (new-pricing.mdx, org-project-controls-governance.mdx)
Total lines processed ~560

Files read: admin/subscriptions/plans.mdx (411 lines), enterprise/analytics.mdx (166 lines), admin/subscriptions/new-pricing.mdx (80 lines sampled), enterprise/org-project-controls-governance.mdx (50 lines sampled)

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