Skip to content

docs(inventor): consolidated Inventor docs (overview + credit counter)#607

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

docs(inventor): consolidated Inventor docs (overview + credit counter)#607
jordanc-relevanceai wants to merge 1 commit into
mainfrom
docs-merge/inventor

Conversation

@jordanc-relevanceai
Copy link
Copy Markdown
Collaborator

@jordanc-relevanceai jordanc-relevanceai commented May 5, 2026

This PR consolidates 2 drafter PRs covering Inventor. Each section below is the original description from a source PR. Opening as draft for review before closing the source PRs.

Source PRs (kept open until confirmed)

Files touched

  • build/agents/inventor.mdx — new page with overview, credit counter section, feedback/bug reporting, and usage guidance
  • admin/subscriptions/plans.mdx — adds Note callouts pointing to the Inventor credit counter section
  • docs.json — adds Inventor to the Agents nav group

Reconciliation note

#597 originally added credit counter content to create-an-agent.mdx because the dedicated Inventor page didn't exist yet. With #594 introducing that page, the credit counter belongs there rather than on the creation flow page. One coherent Inventor doc, one cross-reference from Plans.


#594 — docs(TSP-1172): add Inventor documentation

Summary

  • Adds /build/agents/inventor.mdx — a new documentation page for the Inventor AI-powered agent and tool builder
  • Documents the sidebar interface, how to write effective descriptions, and feedback features (thumbs up/down, bug reporting popup, automatic failure detection)
  • Updates docs.json to add the page to navigation under Agents, positioned after "Create an Agent"

Linear issue

https://linear.app/relevance/issue/TSP-1172/

Test plan

  • Page renders correctly in Mintlify preview
  • Navigation entry appears in the Agents section after "Create an Agent"
  • All internal links resolve (/build/agents/create-an-agent, /get-started/support)
  • Headings are in sentence case
  • No banned words used

#597 — docs(TSP-1171): document real-time credit counter in Inventor interface

Summary

  • Adds a ### Credit usage in the Inventor sidebar subsection to the Option 1: Invent an Agent section in build/agents/create-an-agent.mdx, describing the real-time "X credits used" counter with coins icon, how it updates during AI interactions, and how it differs from the org-wide counter
  • Adds a <Note> callout to both billing tabs in admin/subscriptions/plans.mdx (under the individual Agent-level monitoring section) pointing readers to the Inventor interface details

Test plan

  • Verify the new subsection renders correctly under Option 1 on the Create an Agent page
  • Verify the <Note> callouts appear in both the New billing and Old billing tabs on the Plans and credits page
  • Verify all cross-reference links resolve correctly

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


Linear

Combines two drafter PRs covering Inventor:

- TSP-1172 (#594): new Inventor page at build/agents/inventor.mdx with
  overview, feedback/bug reporting, and usage guidance
- TSP-1171 (#597): real-time credit counter in the Inventor sidebar,
  with cross-references from Plans and credits

Reorganized so the credit counter content lives on the dedicated
Inventor page (its natural home) rather than create-an-agent.mdx.
The Plans and credits page now points to the new Inventor section
directly. Adds inventor to the Agents nav group.
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 5, 2026

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

Project Status Preview Updated (UTC)
relevanceai 🟢 Ready View Preview May 5, 2026, 4:46 AM

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

@jordanc-relevanceai jordanc-relevanceai added the docs-drafter Documentation drafted by Claude label May 5, 2026
@jordanc-relevanceai jordanc-relevanceai changed the title docs(inventor): consolidate Inventor docs (overview + credit counter) docs(inventor): consolidated Inventor docs (overview + credit counter) May 5, 2026
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.

2 participants