Skip to content

docs: consolidate concurrency usage chart documentation (replaces #710, #725) - #738

Draft
jordanc-relevanceai wants to merge 1 commit into
mainfrom
docs/consolidate-concurrency-chart
Draft

docs: consolidate concurrency usage chart documentation (replaces #710, #725)#738
jordanc-relevanceai wants to merge 1 commit into
mainfrom
docs/consolidate-concurrency-chart

Conversation

@jordanc-relevanceai

Copy link
Copy Markdown
Collaborator

Summary

Consolidates the two open PRs that rewrote the same Concurrency usage section into one change. Branched from main.

  • enterprise/analytics.mdx — stacked bar chart description, Running/Queued bands, when queued tasks appear, per-project breakdown as a manager-only toggle, tooltip layout, link to System Quotas.
  • admin/subscriptions/plans.mdx — corrects "time-series area chart" to "stacked bar chart", describes the two bands, and cross-links the per-project breakdown.

Replaces these PRs (now closed)

PR What it covered Status here
#710 Per-project breakdown: "Org total" / "By project" toggle, organization managers only Folded in — this is the accurate description and it wins the conflict below
#725 Stacked bar chart, Running/Queued bands, tooltip, System Quotas link, plans.mdx correction Folded in, with two corrections

These two directly contradicted each other on the same paragraphs, so they could not both merge.

The conflict, and how it was resolved

#710 said the per-project breakdown is a toggle visible to organization managers. #725 said "The chart always shows a breakdown by project." #710 is right.

In relevance-api-node, the per-project view requires both organization-management permission and the analytics-agent-concurrency-project-breakdown flag — the code comment reads "Per-project breakdown requires both org-management permission and the flag", and without them "the whole org renders as a single band". The flag is at 100% rollout, so the flag half is no longer a reach problem, but the permission gate is real and permanent. Documented as a manager-only toggle.

Other correction

Band colours. #725 described the running band as blue. The running ramp starts at #6858FF — brand indigo/purple — so it is described as purple here. The queued band is genuinely red (#912018#FDA29B ramp), and the chart's own help text says "Red shows tasks queued over the limit."

Verified as accurate and kept

  • Queued tasks only appear once the org hits its concurrent task limit.
  • The queued band stacks on top of the running band.
  • Tooltip has Running and Queued columns, one row per project, Total row at the bottom.
  • /admin/system-limits#concurrent-tasks resolves — that page has a ## Concurrent Tasks heading.
  • The queued band itself is behind analytics-agent-concurrency-queue-depth, also at 100% rollout, so it is safe to document.

Test plan

  • Mintlify preview renders the CardGroup and both Notes on the Analytics page
  • /enterprise/analytics#per-project-breakdown anchor resolves from plans.mdx
  • /admin/system-limits#concurrent-tasks anchor resolves

Folds #710 and #725 into one change. Keeps #710's manager-gated
toggle (correct) over #725's "always shows a breakdown by project",
and keeps #725's queued band, tooltip and System Quotas link.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@mintlify

mintlify Bot commented Jul 31, 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 31, 2026, 6:56 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

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant