Skip to content

docs(TSP-1264): add Inventor delete/restore for agents, tools, and workforces#651

Open
claude[bot] wants to merge 2 commits into
mainfrom
docs/TSP-1264
Open

docs(TSP-1264): add Inventor delete/restore for agents, tools, and workforces#651
claude[bot] wants to merge 2 commits into
mainfrom
docs/TSP-1264

Conversation

@claude
Copy link
Copy Markdown

@claude claude Bot commented Jun 1, 2026

Summary

  • delete-agent.mdx: Added Inventor as a deletion method, added restore section, updated messaging to reflect deletion is no longer permanent, added note about auto-redirect when deleting the currently-edited agent, fixed title case
  • delete-tool.mdx: Added Inventor as a deletion method, added restore section, updated permanent/cannot-be-undone messaging for tool deletion (tool steps remain immediate and unrevertable)
  • delete-workforce.mdx (new): Documents UI and Inventor-based deletion and restoration of workforces
  • docs.json: Added delete-workforce to the Workforce navigation group

Key behavior documented across all pages:

  • Deletion is no longer permanent — deleted resources can be restored via Inventor
  • Delete and restore actions always require user confirmation, even when auto-approve is enabled for other actions
  • Deleting the currently-edited agent in Inventor triggers an automatic redirect

Test plan

  • Verify all headings are sentence case
  • Verify all internal links resolve
  • Verify delete-workforce appears in the sidebar under Workforce
  • Confirm restore steps match actual product behavior

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

🤖 Generated with Claude Code

…tools, and workforces

- Update delete-agent.mdx: add Inventor deletion method, restore section, auto-redirect note, fix permanent/cannot-be-undone messaging, fix title case
- Update delete-tool.mdx: add Inventor deletion method, restore section, update permanent messaging
- Create delete-workforce.mdx: new page documenting UI and Inventor deletion and restoration of workforces
- Update docs.json: add delete-workforce to Workforce navigation group

Destructive actions (delete/restore) always require user confirmation in Inventor even when auto-approve is enabled.

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

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude claude Bot added the docs-drafter Documentation drafted by Claude label Jun 1, 2026
@linear
Copy link
Copy Markdown

linear Bot commented Jun 1, 2026

TSP-1264

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Jun 1, 2026

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

Project Status Preview Updated (UTC)
relevanceai 🟢 Ready View Preview Jun 1, 2026, 7:37 AM

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 1, 2026

🎯 Vibe check

Reviewed: 4 files (3 MDX with issues, 1 docs.json clean)

Scores

Dimension Score What's holding it back
🔴 Consistency 4/10 Product term capitalization is broken across all three files — "agent", "tool", "workforce" used throughout where "Agent", "Tool", "Workforce" are required. Sibling pages (create-an-agent.mdx, create-a-tool.mdx, create-a-workforce.mdx) all capitalize correctly. This is a systematic miss, not a one-off.
🟡 Technical clarity 7/10 Most steps are specific with exact UI names. Main gap: tool step deletion's "cannot be undone" is buried in a bullet point rather than surfaced as a Warning. Also a minor ambiguity in delete-tool.mdx between "removed immediately" (step 5) and "takes effect immediately upon saving" (What happens section).
🟢 Non-technical clarity 9/10 Straightforward how-to pages. No jargon, no fluff. The note about being redirected after deleting the agent you're currently editing (delete-agent.mdx) is a genuinely useful gotcha.
🟡 Structure 6/10 delete-tool.mdx uses H1 (#) for two major body sections, which creates duplicate H1s since the frontmatter title already acts as H1. Sibling page create-a-tool.mdx uses ## for sections. Bold text is used as a definition label where a proper heading belongs.

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

Overall vibe: The content itself is solid — clear steps, good coverage of UI and Inventor paths, and the restore capability is called out appropriately. The main problem is a pervasive product-term capitalization failure across all three files that makes the pages inconsistent with every sibling in these directories. Fix capitalization and the H1 hierarchy in delete-tool.mdx and these pages are ready.

🔧 Issues (22)

build/agents/delete-agent.mdx

  • :2 — title "Delete an agent""Delete an Agent" (product term; sibling page is "Create an Agent")
  • :3 — description "Remove agents from Relevance AI""Remove Agents from Relevance AI"
  • :7"delete agents from the Relevance AI interface""delete Agents from the Relevance AI interface"
  • :16"next to the agent you want to delete""next to the Agent you want to delete"
  • :22"Inventor to delete an agent during a conversation""delete an Agent"
  • :24"Ask Inventor to delete an agent""delete an Agent" / "Delete the [agent name] agent""Delete the [Agent name] Agent"
  • :28"if you delete the agent you are currently editing""the Agent you are currently editing"
  • :33"Deleted agents can be restored""Deleted Agents"
  • :36"Ask Inventor to restore the agent""the Agent" / "Restore the [agent name] agent""the [Agent name] Agent"
  • :42–43 — accordion content: "deleted agent" / "deleted agents""deleted Agent" / "deleted Agents"

build/workforces/delete-workforce.mdx

  • :2 — title "Delete a workforce""Delete a Workforce" (sibling page is "Create a Workforce")
  • :3 — description "Remove workforces from Relevance AI""Remove Workforces from Relevance AI"
  • :6"delete workforces from the Relevance AI interface""delete Workforces"
  • :11"next to the workforce you want to delete""the Workforce you want to delete"
  • :19"delete a workforce" / "Delete the [workforce name] workforce""delete a Workforce" / "Delete the [Workforce name] Workforce"
  • :24"Deleted workforces can be restored""Deleted Workforces"
  • :27–28"restore the workforce" / "Restore the [workforce name] workforce" → capitalize both
  • :33 — accordion: "deleted a workforce" / "deleted workforces can be restored" / "restore the workforce by name" → capitalize all

build/tools/delete-tool.mdx

  • :2 — title "Delete a tool or tool step""Delete a Tool or Tool step"
  • :7 — heading "Differences between deleting a tool and deleting a tool step""…a Tool and deleting a Tool step"
  • :10–11 — bullet list: "all agents""all Agents"; "this tool" (×2) → "this Tool"
  • :15"deleted tools can be restored""deleted Tools"
  • :17–19 — Warning callout: "Any agents""Any Agents"; "this tool""this Tool"; "agents use this tool""Agents use this Tool"
  • :30"If agents are using the tool""If Agents are using the Tool"; "those agents first""those Agents first"; "alternative tools""alternative Tools"
  • :38"within an agent""within an Agent"
  • :52 — heading "What happens when you delete a tool""…delete a Tool"
  • :57"Any agents using this tool""Any Agents using this Tool"
  • :62 — heading "Restore a deleted tool""Restore a deleted Tool"
  • :64–68"Deleted tools can be restored" / "restore the tool" → capitalize "Tool"
  • :75 — heading "Steps to delete a tool step""Steps to delete a Tool step"
  • :92 — heading "What happens when you delete a tool step""…a Tool step"
  • :99"upon saving the tool""saving the Tool"
  • :85 vs :99 — minor ambiguity: step 5 says "The step will be removed immediately"; the What happens section (line 99) says "The deletion takes effect immediately upon saving the tool." It's unclear whether the removal is instant or requires an explicit save — clarify which is true.
🧩 Component suggestions (3)
  • build/tools/delete-tool.mdx:9**Tool deletion vs. tool step deletion:** is bold text acting as a section label. CLAUDE.md says not to mix bold text with heading formats for section titles. Replace with ### Tool deletion vs. Tool step deletion (no trailing colon on headings).
  • build/tools/delete-tool.mdx:11"This cannot be undone." is the only irreversibility warning for tool step deletion, and it's buried inside a bullet point. Elevate to a <Warning> callout — just as tool deletion gets a Warning on lines 17–19, tool step deletion should too. Something like: <Warning>Deleting a tool step cannot be undone. Any steps that reference its output will show errors until updated.</Warning>
  • build/tools/delete-tool.mdx:13,71# Delete a tool and # Delete individual tool steps are H1 headings in the page body. The frontmatter title already acts as the page's H1, so these create duplicate H1s. Sibling page create-a-tool.mdx uses ## for all sections. Change both to ##.
🏗️ Page structure (1)
  • build/tools/delete-tool.mdx — the two-topic structure (deleting a whole tool vs. deleting a tool step) is logical, but the H1/H2 hierarchy problem (flagged above) means the two sections don't sit at the right level in the visual hierarchy. After fixing to ##, the page reads: intro summary → Warning → Before you delete → Delete via UI → Delete via Inventor → What happens → Restore → [then] Delete individual Tool steps. That's a clean progression once the heading levels are corrected.
✅ Clean files (1)

docs.json — navigation placement is correct. The three delete pages are placed after their respective share pages in each section group, which is a logical order.

🔋 Credit usage
Item Count
Files reviewed 4 (3 MDX + docs.json grep)
Context pages read 3
Total lines processed ~416

Files read: build/agents/delete-agent.mdx (44 lines), build/tools/delete-tool.mdx (100 lines), build/workforces/delete-workforce.mdx (35 lines), build/agents/create-an-agent.mdx (91 lines), build/tools/create-a-tool.mdx (101 lines), build/workforces/create-a-workforce.mdx (45 lines)

… not undelete

Per api-node PR #15045, the delete tools are 'Irreversible — cannot be undone',
and the restore tools are relevance_restore_*_version: they duplicate a chosen
version into the draft slot (publish to make live), they do not recover a
deleted resource. Corrected the agent/tool/workforce delete pages and FAQs,
which had framed deletion as reversible and restore as undelete.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 3, 2026

🎯 Vibe check

Reviewed: 4 files (3 MDX with issues, 1 docs.json with a minor navigation note)

Scores

Dimension Score What's holding it back
🟡 Consistency 5/10 Product term capitalization ("agent", "tool", "workforce") is systematically lowercase in body text across all three pages — every file has widespread violations of the capitalization rule.
🟢 Technical clarity 8/10 One within-file contradiction in delete-tool.mdx: the steps say a tool step "will be removed immediately" but the summary list says "deletion takes effect immediately upon saving."
🟢 Non-technical clarity 9/10 Clear, plain language throughout. Permanence warnings are prominent. The restore-vs-undelete distinction is handled well.
🟡 Structure 7/10 delete-tool.mdx uses H1 (#) headings for in-page sections — these should be H2 (##). Navigation ordering in docs.json is inconsistent (tools lists delete before share; agents and workforces list share before delete).

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

Overall vibe: Solid, focused pages — the content is accurate, warnings are well-placed, and the restore/version-rollback distinction is cleanly communicated. Two things need fixing before merge: product term capitalization is broken throughout all three files, and delete-tool.mdx has structural H1-in-body issues.

🔧 Issues (19)

Capitalization — product terms must be capitalized throughout body text

  • build/agents/delete-agent.mdx:7 — "the agent's syncs and scheduled triggers" → "the Agent's syncs and scheduled triggers"
  • build/agents/delete-agent.mdx:16 — "the agent you want to delete" → "the Agent you want to delete"
  • build/agents/delete-agent.mdx:22,24,25,28,33 — "agent" (all instances in body paragraphs) → "Agent"
  • build/agents/delete-agent.mdx:43,44 — Accordion body text: "my deleted agent", "an agent is permanent", "an existing agent" → capitalize "Agent" throughout
  • build/tools/delete-tool.mdx:10,11 — "the tool from your project and all agents" / "an existing tool's workflow" → "Tool", "Agents", "Tool's"
  • build/tools/delete-tool.mdx:15,23,30 — "Deleting a tool is permanent", "any agents are using it", "If agents are using the tool" → capitalize "Tool" and "Agents"
  • build/tools/delete-tool.mdx:47,49,52,55,57,64,65,74,80 — repeated lowercase "tool" and "agents" throughout body paragraphs → "Tool", "Agents"
  • build/workforces/delete-workforce.mdx:6,11,14,19,24,34 — "a workforce is permanent", "the workforce you want to delete", etc. → "Workforce" throughout

Within-file contradiction

  • build/tools/delete-tool.mdx:86,97,100 — Step 5 says "The step will be removed immediately," but the summary list at line 97 says "The step is immediately removed from the tool's workflow" while line 100 says "The deletion takes effect immediately upon saving the tool." Lines 97 and 100 contradict each other: if it's immediate, there's no need to save; if saving is required, it's not immediate. Clarify whether the deletion is staged (requires save) or committed on click.

H1 headings in page body

  • build/tools/delete-tool.mdx:13# Delete a tool uses H1 in the page body. Mintlify sets the H1 from the frontmatter title. Change to ## Delete a tool.
  • build/tools/delete-tool.mdx:72# Delete individual tool steps — same issue; change to ## Delete individual tool steps.

Navigation ordering

  • docs.json:198 — For tools, delete-tool appears before share-your-tool. For agents and workforces, share comes before delete. Flip tools to match: share-your-tool, then delete-tool.
🧩 Component suggestions (1)
  • build/tools/delete-tool.mdx:9**Tool deletion vs. tool step deletion:** is a bold label immediately under the H2 heading "Differences between deleting a tool and deleting a tool step." It's redundant — the heading already names the contrast. Remove the bold label; the bullet list reads fine without it.
✅ Clean files (1)

build/agents/delete-agent.mdx — clean structure, good use of a FAQ accordion, and the restore-vs-undelete distinction is clearly communicated. Only the capitalization issues apply here (tracked in Issues above).

🔋 Credit usage
Item Count
Files reviewed 4 (3 MDX + docs.json grep)
Context pages read 5
Total lines processed ~480

Files read: build/agents/delete-agent.mdx (46 lines), build/tools/delete-tool.mdx (101 lines), build/workforces/delete-workforce.mdx (36 lines), build/agents/create-an-agent.mdx (91 lines), build/workforces/create-a-workforce.mdx (44 lines), build/tools/create-a-tool.mdx (102 lines), build/agents/share-your-agent.mdx (30 lines, partial), build/workforces/share-your-workforce.mdx (30 lines, partial)

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