Skip to content

docs(TSP-1438): add builder home page Status section - #811

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

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

Conversation

@claude

@claude claude Bot commented Sep 9, 2026

Copy link
Copy Markdown

Summary

  • Adds build/home-page.mdx documenting the new Status section on the builder home page
  • Covers what each row displays (name, 30-day health strip, performance score chart), the three click-through interactions, and the Configure panel
  • Notes that the performance chart links to Analytics, which is an Enterprise feature
  • Updates docs.json to add the page to the Overview group in the Build tab, immediately after build/introduction

Linear: https://linear.app/relevance/issue/TSP-1438/

Test plan

  • Page renders correctly at /build/home-page
  • Navigation shows "Home page" under the Build > Overview group
  • Internal links resolve: Task Operations, Analytics, Create an Agent, Create a Workforce
  • All headings are sentence case
  • No orphaned pages

🤖 Generated with Claude Code

Documents the Status section on the builder home page — health strips,
performance charts, interactive click-through, and the Configure panel.

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

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

@linear

linear Bot commented Sep 9, 2026

Copy link
Copy Markdown

TSP-1438

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 2 files (1 with issues, 1 clean)

Scores

Dimension Score What's holding it back
🟡 Consistency 6/10 "agents" and "workforces" appear lowercase 8+ times throughout the file where they refer to the Relevance AI product features Agent and Workforce (lines 7, 11, 14, 25, 28, 42, 51, 56).
🟡 Technical clarity 8/10 "task health" and "performance score" are introduced as named elements in the Status section table without defining what they measure — a reader configuring the section won't know what they're optimizing for.
🟡 Non-technical clarity 7/10 Same gap: the two most important concepts on the page ("30-day health strip" and "performance score chart") are named but never explained. What does a red bar mean vs a green one? What does the performance score actually reflect?
🟢 Structure 9/10 Clean progression for a reference page. Minor: the table in "What the Status section shows" and the CardGroup in "Clicking through to details" describe the same 3 elements from slightly different angles — small redundancy, not a blocker.

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

Overall vibe: Solid, well-structured reference page — correct components, clean headings, no banned words, no British spellings, and the docs.json placement under "Overview" in the Build tab is right. The one pattern that needs a sweep is the consistent lowercasing of "agents" and "workforces" throughout; CLAUDE.md requires these to be capitalized when referring to the Relevance AI product features, and they are here.

🔧 Issues (9)
  • build/home-page.mdx:7 — "your most important agents and workforces" → "your most important Agents and Workforces" (product terms)
  • build/home-page.mdx:11 — "up to five agents or workforces" → "up to five Agents or Workforces"
  • build/home-page.mdx:14 — "The agent or workforce name" → "The Agent or Workforce name"
  • build/home-page.mdx:25 — "Clicking the agent or workforce name opens it in the builder." → "Clicking the Agent or Workforce name…"
  • build/home-page.mdx:28 — "filtered to that agent or workforce" → "filtered to that Agent or Workforce"
  • build/home-page.mdx:42 — "auto-selects agents and workforces" → "auto-selects Agents and Workforces"
  • build/home-page.mdx:51 — "the agents and workforces you want to track" → "the Agents and Workforces you want to track"
  • build/home-page.mdx:56 — "the five agents or workforces with the most recent task activity" → "the five Agents or Workforces…"
  • build/home-page.mdx:4 (description frontmatter) — "your agents and workforces on the builder home page" → same capitalization fix for consistency, though meta descriptions are lower stakes
🧩 Component suggestions (1)
  • build/home-page.mdx:12–17 and build/home-page.mdx:23–33 — The table ("What the Status section shows") and the CardGroup ("Clicking through to details") both list the same three elements: Name, Health strip, Performance chart. The table covers what each element is; the CardGroup covers where each links. Consider combining into a single table with a Links to column (and keep the actual destination URLs as inline links). This removes one heading and the visual duplication of the three element names without losing any information. The CardGroup navigation value is modest since these aren't distinct paths a user chooses between.
🏗️ Page structure (1)
  • build/home-page.mdx:16–17 — The table introduces "30-day health strip" and "Performance score chart" as named UI elements but doesn't define what they measure. One sentence each would close this gap: e.g., "Color-coded daily bars showing task success rate over the past 30 days — green for healthy, red for errors." and "A sparkline of the agent's or workforce's performance score over recent runs." Without this, the Status section's two most distinctive elements are opaque to new users.
✅ Clean files (1)

docs.json — navigation entry for build/home-page is correctly placed under the "Overview" group in the "Build with Relevance AI" tab, alongside build/introduction. No issues.

🔋 Credit usage
Item Count
Files reviewed 2
Context pages read 3
Total lines processed ~280

Files read: build/home-page.mdx (57 lines), build/introduction.mdx (62 lines), enterprise/analytics.mdx (166 lines), build/agents/give-your-agent-tasks/tasks-page.mdx (40 lines), docs.json (1,160 lines)

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