docs(TSP-1172): add Inventor documentation#594
Conversation
Documents the Inventor AI-powered agent/tool builder: sidebar interface, feedback buttons (thumbs up/down), bug reporting flow, and automatic failure detection. Adds page to navigation after Create an Agent. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
🎯 Vibe check —
|
| Dimension | Score | What's holding it back | |
|---|---|---|---|
| 🟡 | Consistency | 6/10 | "agent" and "tool" are left lowercase throughout when referring to Relevance AI product features — inconsistent with every other page in the section. |
| 🟢 | Technical clarity | 9/10 | UI element names are specific, tips are actionable, the automatic failure detection behavior is a useful non-obvious detail. |
| 🟢 | Non-technical clarity | 9/10 | Plain language throughout, good example, concept is grounded before instructions begin. |
| 🟡 | Structure | 7/10 | Bold text used as a section header instead of a proper heading; no closing CTA for a concept page. |
🔧 Issues
-
Lines 7, 11, 13, 23, 57, 61, 65 — "agent(s)" and "tool(s)" are lowercase throughout when they refer to Relevance AI product features. Every sibling page (
create-an-agent.mdx,agents.mdx) capitalizes these consistently. Specific instances:- Line 7: "Inventor generates agents and tools" → "Inventor generates Agents and Tools"
- Line 7: "creating a new agent (the Invent option) or a new tool" → "creating a new Agent … or a new Tool"
- Line 11: "Inventor generates the agent or tool" → "generates the Agent or Tool"
- Line 13: "For agents, Inventor configures the prompt and suggests relevant tools. For tools, it builds out the steps and logic of the tool." → "For Agents … suggests relevant Tools. For Tools … logic of the Tool."
- Line 23: "ask it to add a tool … or change how the agent behaves" → "add a Tool … how the Agent behaves"
- Line 57: "building a tool or agent for the first time" → "building a Tool or Agent"
- Line 61: "complex agents" → "complex Agents"
- Line 65: link text "Create an agent" → "Create an Agent" (matches the linked page's title)
-
Line 15 —
**Tips for effective descriptions:**uses bold text as a section header. Per the content standards, use a proper heading instead:#### Tips for effective descriptions
🏗️ Page structure
- No closing CTA. This is a concept page (it explains what Inventor is), so readers who finish it need somewhere to go. A short
## Get startedsection or## What's next?with a card or two would round it off — natural destinations are/build/agents/create-an-agent(where Inventor is actually invoked) and/build/agents/build-your-agent/prompt(what to do once Inventor generates a first draft).
⚠️ Contradiction watch
None found.
✨ Overall vibe
Solid page — the content is accurate, the example description is genuinely useful (mirrors what create-an-agent.mdx uses, which is fine), and the automatic bug-reporting behavior is exactly the kind of non-obvious detail worth documenting. The capitalization inconsistency is the main thing to fix; everything else is a quick polish pass.
Note on docs.json: The navigation change adds build/agents/inventor into the Agents group immediately after build/agents/create-an-agent, which is the correct placement — Inventor is invoked during agent creation. No issues with the nav structure.
🔋 Credit usage
| Item | Count |
|---|---|
| Files reviewed | 1 (+ docs.json nav check) |
| Context pages read | 2 |
| Total lines processed | ~464 |
Files read:
build/agents/inventor.mdx(67 lines)build/agents/create-an-agent.mdx(91 lines)get-started/core-concepts/agents.mdx(206 lines)docs.json(100 lines, partial)
|
Consolidated into #607 as part of trimming the docs-drafter queue. Branch kept; PR can be reopened if needed. |
Summary
/build/agents/inventor.mdx— a new documentation page for the Inventor AI-powered agent and tool builderdocs.jsonto add the page to navigation under Agents, positioned after "Create an Agent"Linear issue
https://linear.app/relevance/issue/TSP-1172/
Test plan
/build/agents/create-an-agent,/get-started/support)🤖 Generated with Claude Code