Skip to content

docs(TSP-1229): document Inventor draft/publish model#616

Open
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1229
Open

docs(TSP-1229): document Inventor draft/publish model#616
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1229

Conversation

@claude
Copy link
Copy Markdown

@claude claude Bot commented May 12, 2026

Summary

  • New page build/agents/publish-your-agent.mdx — dedicated reference covering the draft/publish model, visual indicators, how to publish, testing with drafts, version history, granular per-tool editing, and publish checks
  • Updated build/agents/create-an-agent.mdx — added a "Draft and publish" section explaining all changes save as drafts and require explicit publishing, with a link to the new reference page
  • Updated get-started/quick-start-guide.mdx — added an explicit Publish step (step 7) to the Inventor creation flow, and a new "Step 4: Publish your changes" section before "Share and deploy"
  • Updated docs.json — added build/agents/publish-your-agent to the Agents navigation group, after create-an-agent

This documents the breaking change introduced in PR #14651: Inventor no longer auto-publishes. All agent edits (create, config, tools) save as drafts and require an explicit Publish + confirmation step to go live. Even with auto-approve enabled, publishing requires explicit user confirmation.

Resolves: https://linear.app/relevance/issue/TSP-1229/

Test plan

  • Verify build/agents/publish-your-agent renders correctly in Mintlify preview
  • Confirm all internal links (/build/agents/publish-your-agent, /build/agents/build-your-agent/evals#publish-checks) resolve
  • Check new nav entry appears correctly in the Agents sidebar section
  • Review all headings are sentence case
  • Confirm no banned words used (powerful, seamlessly, effortlessly, unlock, supercharge, robust, leverage)

🤖 Generated with Claude Code

Inventor now saves all agent changes as drafts and requires explicit
publishing. Add a dedicated draft/publish reference page, update the
agent creation guide with a draft/publish section, and add a required
Publish step to the quick start guide.

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

linear Bot commented May 12, 2026

TSP-1229

@github-actions
Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 4 files (2 with issues, 2 clean)

Scores

Dimension Score What's holding it back
🟡 Consistency 8/10 "Builder" capitalized on publish-your-agent.mdx:7 but lowercase ("agent builder") everywhere else in that file and in create-an-agent.mdx. Same issue on quick-start-guide.mdx:50 with "Agent builder".
🟢 Technical clarity 9/10 Option 1 (Invent) in the quick-start guide embeds a publish step (step 7) that Options 2 and 3 don't have — creates an uneven experience for users on different paths.
🟢 Non-technical clarity 9/10 Clear and accessible throughout.
🟢 Structure 9/10 The publish-step asymmetry in the quick-start guide is the main gap (see issues).

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

Overall vibe: Clean, well-written PR. The draft/publish model is explained clearly and reinforced across all three pages without over-duplicating — each page covers just what its audience needs and links to the canonical source for the rest. Two minor capitalization inconsistencies to clean up and one structural asymmetry in the quick-start guide.

🔧 Issues (2)
  • build/agents/publish-your-agent.mdx:7 — "Inventor and Builder" → should be "Inventor and the agent builder" (lowercase). The rest of the file — lines 13 and 21 — correctly uses "agent builder", as does create-an-agent.mdx throughout. "Builder" as a standalone capitalized product name isn't established anywhere else.

  • get-started/quick-start-guide.mdx:50 — "in the Tools section of the Agent builder" → "agent builder" should be lowercase. Inconsistent with line 111 of the same file ("Open your agent in the agent builder").

🏗️ Page structure (1)
  • get-started/quick-start-guide.mdx:51 — Option 1 (Invent) includes a 7th step — "Click Publish and confirm in the dialog" — but Options 2 and 3 have no equivalent publish step. Since Step 4 covers publishing for all paths, Option 1 users see the publish reminder twice while Options 2 and 3 users only see it in Step 4. Either remove step 7 from Option 1 (Step 4 handles it consistently for everyone), or add a brief publish reminder to Options 2 and 3 so all paths are parallel.
✅ Clean files (2)

docs.json — navigation change is correct; publish-your-agent added immediately after create-an-agent in the Agents group, which is the right place.

build/agents/publish-your-agent.mdx — near-clean aside from the one capitalization slip on line 7. The Warning callout, the auto-approve clarification, and the Publish Checks cross-reference are all correct.

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

Files read: build/agents/create-an-agent.mdx (106 lines), build/agents/publish-your-agent.mdx (48 lines), get-started/quick-start-guide.mdx (146 lines), docs.json (928 lines), get-started/core-concepts/agents.mdx (226 lines), get-started/introduction.mdx (163 lines)

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.

0 participants