Skip to content

docs: consolidate Inventor voice interview mode (replaces #748, #753) - #754

Draft
jordanc-relevanceai wants to merge 1 commit into
mainfrom
docs/consolidate-inventor-voice
Draft

docs: consolidate Inventor voice interview mode (replaces #748, #753)#754
jordanc-relevanceai wants to merge 1 commit into
mainfrom
docs/consolidate-inventor-voice

Conversation

@jordanc-relevanceai

Copy link
Copy Markdown
Collaborator

Summary

Consolidates the two open PRs documenting Inventor's voice interview mode (TSP-1374) into one change. Branched from main.

  • build/invent/invent.mdx (primary) — new Voice interview mode section, a Talk to Inventor capability card, a Talk to Inventor button tab in the access points, and a credit-usage note
  • build/agents/create-an-agent.mdx — a short Note under Option 1 pointing at the Inventor page
  • get-started/quick-start-guide.mdx — one-line cross-reference

Replaces these PRs (now closed)

PR What it covered Status here
#748 Voice mode written up in full on create-an-agent.mdx Folded in as detail on the Inventor page, not duplicated on create-an-agent.mdx
#753 Voice mode on invent.mdx + cross-refs Kept as the base — larger, and it anchors the content on the Inventor page

Both PRs documented the same feature from the same Linear issue, and both edited create-an-agent.mdx and quick-start-guide.mdx in the same place. They would have conflicted on merge.

Where the two drafts disagreed

Placement. #748 put the full write-up on create-an-agent.mdx; #753 put it on invent.mdx and left a pointer behind. Went with #753 — voice mode is an Inventor capability, and create-an-agent.mdx already delegates the rest of the Inventor detail to that page. Duplicating it in both places would mean two copies to keep in sync as the feature moves out of experimental.

Two details from #748 were kept, because #753 did not have them:

Not verified

Neither draft has been fact-checked against the product PRs (#16804 backend, #16823 frontend) or against the rollout. Both flag the feature as experimental and limited-rollout, which is the safe framing, but the specifics below are worth a pass before merge:

  • The End conversation / End & build labels
  • The credit claim that "the realtime platform fee is waived for Inventor interviews" (from Add documentation for Inventor voice interview mode #753) — this is a billing statement and the one most worth confirming
  • Whether the experimental caveat should name a flag or stay generic

Test plan

  • Mintlify preview renders the Voice interview mode section and the CardGroup at the end of the session
  • The new Talk to Inventor button tab renders inside the existing access-points <Tabs>
  • /build/invent/invent#voice-interview-mode resolves from both create-an-agent.mdx and quick-start-guide.mdx

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

mintlify Bot commented Aug 5, 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 Aug 5, 2026, 4:23 AM

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

@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

🎯 Vibe check

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

Scores

Dimension Score What's holding it back
🟡 Consistency 6/10 quick-start-guide.mdx systematically lowercases product terms (agent, tools, knowledge, triggers, alerts) that create-an-agent.mdx — also changed in this PR — correctly capitalizes throughout. Same sentence at line 50 writes "tools" and "Tools" for the same concept.
🟡 Technical clarity 7/10 invent.mdx declares Inventor is "pilot for Enterprise plans only" but neither create-an-agent.mdx nor quick-start-guide.mdx mentions this plan restriction. Non-Enterprise users following either page will hit a dead end with no warning.
🟢 Non-technical clarity 9/10 No issues found. Plain language, good concrete examples, appropriate context for first-time users.
🟡 Structure 7/10 Voice interview steps are duplicated between a tab and a standalone section in invent.mdx, with inconsistent terminology for the same UI element. invent.mdx has no closing CTA. One <CardGroup> describes effects, not navigable choices.

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

Overall vibe: Three well-written pages with clear prose and a logical flow — the quick-start guide in particular reads well for a first-time user. The main drag is a consistency gap between the two agent-creation pages: quick-start-guide.mdx lowercases product terms throughout while create-an-agent.mdx gets them right, and both are in this PR. The missing Enterprise-only caveat on the Inventor option is a user-facing problem, not just a style nit.

🔧 Issues (2)
  • get-started/quick-start-guide.mdx:41,49,50,60,67,80–82,93,110–114,138 — "agent/agents", "tools", "knowledge", "triggers", "alerts" are lowercase throughout body text. As Relevance AI product terms, these should be capitalized: Agent, Tools, Knowledge, Triggers, Alerts. The inconsistency is especially visible because create-an-agent.mdx (also in this PR) capitalizes all of these correctly. Worst instance is line 50: "Connect any integrations your tools need … in the Tools section of the Agent builder" — "tools" and "Tools" in the same sentence for the same concept.

  • build/invent/invent.mdx:103 vs build/agents/create-an-agent.mdx:43 and get-started/quick-start-guide.mdx:47invent.mdx labels the agent-creation entry point "Build with Inventor"; the other two pages say "Select Invent". These may describe two different UI paths (a header button vs. a dialog option), but if they're the same action the names should match. Verify against the live UI and align.

🧩 Component suggestions (2)
  • build/invent/invent.mdx:240–250<CardGroup cols={3}> in the "About you" tab lists Tone and language / Domain assumptions / Personalization. These are descriptive effects of a single setting, not navigable options or parallel choices. Per CLAUDE.md, CardGroup is not for "short adjective or property lists." Replace with a plain <ul> — for example:

    - **Tone and language** — simpler explanations for non-technical users, more precise technical language for engineers.
    - **Domain assumptions** — if you're in sales, it won't default to engineering-flavored tool designs.
    - **Personalization** — addresses you by first name at natural moments.
    
  • build/invent/invent.mdx:266–268<Info> on session persistence ("Closing the panel or refreshing the page doesn't delete your conversation history — sessions persist and can be resumed at any time") is a positive reassurance, not neutral information. Swap to <Check>.

🏗️ Page structure (2)
  • build/invent/invent.mdx:133–143 and build/invent/invent.mdx:179–189 — the steps for starting a voice interview appear twice: once in the "Talk to Inventor button" tab under "Where to find Inventor", and again in the standalone "### How to start a voice interview" section. They also use different names for the same UI element — "voice session overlay" (tab) vs "full-screen overlay" (section). Make the standalone section canonical with the full detail, and replace the tab steps with a one-line reference: "See voice interview mode for full instructions."

  • build/invent/invent.mdx — no closing CTA. As a concept/feature page, it should end with a "What's next?" pointing readers to where they can act. Natural next steps: /build/agents/create-an-agent ("Create your first Agent with Inventor") and /build/tools/create-a-tool ("Invent a Tool").

⚠️ Contradictions (1)
  • build/invent/invent.mdx:7 states Inventor is "a pilot for Enterprise plans only" and directs non-Enterprise users elsewhere. build/agents/create-an-agent.mdx:35–50 and get-started/quick-start-guide.mdx:39–54 both present "Invent an Agent" as a standard first option with no plan caveat. A user on a Starter or Pro plan following the quick-start guide will select Invent, hit the Enterprise gate, and have no context for why it's blocked. Add a brief callout to the Inventor option on both pages — e.g., a <Note> pointing to the invent.mdx access request path.
✅ Clean files (1)

build/agents/create-an-agent.mdx — capitalization correct throughout, no banned words, good use of <Tip> and <Note>, clear structure with a "What's next?" section.

🔋 Credit usage
Item Count
Files reviewed 3
Context pages read 4
Total lines processed ~1,287

Files read: build/agents/create-an-agent.mdx (95 lines), build/invent/invent.mdx (309 lines), get-started/quick-start-guide.mdx (139 lines), get-started/core-concepts/agents.mdx (230 lines), build/tools/create-a-tool.mdx (102 lines), get-started/core-concepts/mcp-plugins.mdx (213 lines), get-started/chat/introduction.mdx (199 lines)

@jordanc-relevanceai jordanc-relevanceai self-assigned this Aug 5, 2026
@jordanc-relevanceai

Copy link
Copy Markdown
Collaborator Author

Blocked on rollout — do not merge yet.

Fact-checked against PostHog. inventor-voice-mode-fe (flag 791879) has a single release condition: a person-property match on one internal email address, danial@relevanceai.com. It has never been called.

No customer can see the Talk to Inventor button, so this page would send readers looking for a control that isn't there. Same call #742 made on the eval cost-breakdown columns.

The content itself is fine and worth keeping — leaving this as a draft rather than closing it. Revisit when the flag widens beyond internal.

Two things to re-check at that point, since neither was verifiable now:

  • the End conversation / End & build button labels
  • "the realtime platform fee is waived for Inventor interviews" — a billing claim

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