Skip to content

docs(TSP-1478-pending): add Invent Workbench accordion - #829

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

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

Conversation

@claude

@claude claude Bot commented Sep 22, 2026

Copy link
Copy Markdown

Summary

  • Adds an Invent Workbench accordion to the "Set up and use Invent" tab of build/invent/invent.mdx
  • Documents the tabbed interface that renders when you open agents, tools, or knowledge tables from the Invent panel
  • Covers how tabs accumulate, how to switch and close them, session persistence, and the early access status

Rollout status

Early access — currently limited to specific Relevance staff via ia-v2-fe flag. Broader rollout flag (ia-v2-experiment) exists but is inactive. Source: verified from product code in relevance-api-node PR #18468.

References

Test plan

  • Accordion renders correctly under the "Set up and use Invent" tab
  • Steps inside accordion display correctly
  • Note callout is well-formed (no attributes)
  • All headings are sentence case
  • No broken links introduced

@claude claude Bot added the docs-drafter Documentation drafted by Claude label Sep 22, 2026
@mintlify

mintlify Bot commented Sep 22, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
relevanceai 🟢 Ready View Preview Oct 8, 2026, 2:19 AM

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

@vercel

vercel Bot commented Sep 22, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
relevance-docs Ready Ready Preview Oct 8, 2026 2:19am UTC

Request Review

@linear

linear Bot commented Sep 22, 2026

Copy link
Copy Markdown

TSP-1478

@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 10/10 No issues found.
🟡 Technical clarity 8/10 Two #alerts-accordion-title anchor links that may be broken; "IA v2" unexplained jargon in a public-facing Note.
🟢 Non-technical clarity 9/10 One unexplained internal label ("IA v2") in the Workbench Note could confuse external readers.
🟢 Structure 10/10 No issues found.

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

✨ Overall vibe: Clean, well-structured hub page that reads correctly and uses components appropriately. The new Invent Workbench accordion fits naturally into the "Set up and use Invent" tab with correct Steps usage and a sensible access caveat. Two anchor links need a quick verification before publishing.

🔧 Issues (2)
  • site/content/docs/build/invent/invent.mdx:219 — [Alerts](/build/invent/invent#alerts-accordion-title) uses the anchor #alerts-accordion-title. The <Accordion title="Alerts"> at line 229 has no explicit id prop, so Mintlify would normally generate #alerts from the title. The *-accordion-title suffix pattern looks non-standard — verify in the rendered output that this anchor actually scrolls to the Alerts accordion, and fix or add an explicit id if it doesn't. Same link appears at line 317.

  • site/content/docs/build/invent/invent.mdx:207 — "Invent Workbench is part of the IA v2 experience" — "IA v2" is unexplained internal versioning jargon. External readers have no frame of reference for it. Either remove it (the rest of the sentence conveys the access restriction on its own) or replace it with something like "the updated Relevance AI interface."

⚠️ Contradictions (0 — context check passed)

Checked against build/agents/build-your-agent/version-history.mdx and build/agents/evals/introduction.mdx. No conflicting claims found — version restore behavior, (restored) suffix, and Evals navigation paths are consistent across all three files.

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

Files read: site/content/docs/build/invent/invent.mdx (383 lines), site/content/docs/build/agents/evals/introduction.mdx (80 lines), site/content/docs/build/agents/build-your-agent/version-history.mdx (~50 lines)

Documents the tabbed Workbench interface that opens when navigating to
resources (agents, tools, knowledge tables) from the Invent panel.
Includes how tabs accumulate, how to switch/close them, and an early
access note scoped to IA v2.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Oct 8, 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 9/10 Two broken anchor links use #alerts-accordion-title which targets an Accordion, not a heading — violates CLAUDE.md link rules. All other naming, capitalization, and spelling are clean.
🟡 Technical clarity 7/10 Broken anchor links will silently 404 for readers. An early-access, internal-staff-only feature (Invent Workbench) is documented in a public accordion with no external-access path, which is confusing rather than informative for customers.
🟢 Non-technical clarity 9/10 Writing is accessible and progressive. "Forward deployed agent" in the frontmatter description is unexplained for first-time readers — the body clarifies it, but it's in the meta description too.
🟡 Structure 7/10 The three Enterprise security accordions (Project isolation, Integration reach, Data egress) are copied verbatim into the FAQ section. CLAUDE.md: "No duplicate content — link to canonical sources instead." Concept page also has no closing CTA.

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

✨ Overall vibe: A well-written, comprehensive reference page with consistently good component choices and clean prose throughout. The main problems are mechanical: two anchor links that won't resolve because they target Accordions rather than headings, and a block of Enterprise security content that appears verbatim in both the body and the FAQ — one copy needs to go.

🔧 Issues (4)
  • invent.mdx:218 — [Alerts](/build/invent/invent#alerts-accordion-title) links to an Accordion title anchor. CLAUDE.md prohibits #section-name links unless the target is a proper heading. The <Accordion title="Alerts"> at line 229 is not a heading, so this anchor will not resolve. Either promote Alerts to a #### heading inside the Tab or link to #invent-features (the nearest real heading) and tell readers which tab to open.
  • invent.mdx:317 — Same broken anchor: [Invent alert channels](/build/invent/invent#alerts-accordion-title). Same fix applies.
  • invent.mdx:91–102 and invent.mdx:359–369 — The "Project isolation", "Integration reach", and "Data egress" accordion bodies appear word-for-word in both the "Enterprise security controls" section and the FAQ. CLAUDE.md: "No duplicate content — link to canonical sources instead." Remove the three duplicates from the FAQ and replace them with a single FAQ entry that links to the Enterprise security controls section: e.g., <Accordion title="How does project isolation and data handling work?">See [Enterprise security controls](#enterprise-security-controls) above.</Accordion>.
  • invent.mdx:207 — The Invent Workbench accordion ends with a Note saying the feature is "currently in early access, available to specific Relevance staff only." Documenting a feature that customers cannot access creates confusion and support noise. Either remove the accordion until the feature is available to customers, or add a clear note at the top of the accordion (not just at the bottom) so readers know immediately this doesn't apply to them.
🏗️ Page structure (1)
  • invent.mdx — No closing CTA. This is a concept/overview page and CLAUDE.md calls for one. The FAQ is a reasonable final section, but readers who finish it have no directed next step. Suggest adding a short ## What's next? or a <CardGroup> after the FAQ with two cards: one linking to /build/agents/evals/introduction (already referenced mid-page) and one to the agent-building guide so readers know what to actually do after reading about Invent.
⚠️ Contradictions (0)

No contradictions found between this file and the context pages read (evals/introduction.mdx, version-history.mdx). The restore-version behavior described in both files (draft landing, (restored) suffix, confirmation required) is consistent.

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

Files read: site/content/docs/build/invent/invent.mdx (383 lines), site/content/docs/build/agents/evals/introduction.mdx (113 lines), site/content/docs/build/agents/build-your-agent/version-history.mdx (89 lines)

@jordanc-relevanceai

Copy link
Copy Markdown
Collaborator

Not public. Will publish once this is GA.

This branch was successfully deployed

2 active deployments
Preview — c7cdb874 Deployed Oct 8, 2026 by vercel[bot]
staging — c7cdb874 Deployed Oct 8, 2026 by mintlify[bot]
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