Skip to content

docs: Add visual label documentation for embeddable and cloneable indicators (TSP-1248)#633

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

docs: Add visual label documentation for embeddable and cloneable indicators (TSP-1248)#633
claude[bot] wants to merge 1 commit into
mainfrom
TSP-1248/docs-update

Conversation

@claude
Copy link
Copy Markdown

@claude claude Bot commented May 19, 2026

Summary

Documents the new Embeddable and Cloneable visual indicator pills added to agent, tool, and workforce list views in PR #14782.

  • Adds a "Sharing labels in list views" section to build/agents/share-your-agent.mdx
  • Adds the same section (briefer) to build/tools/share-your-tool.mdx
  • Adds the same section (briefer) to build/workforces/share-your-workforce.mdx

Each section explains what the two pills mean:

  • Embeddable — an embed option is enabled; the asset runs on the owner's credits
  • Cloneable — the Cloneable Template option is enabled; anyone with the link can clone the asset

The sections are placed after the overview/public-access warning and before the per-feature sections, so users see the at-a-glance context before diving into configuration details.

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

Test plan

  • Verify sentence case on all new headings
  • Verify no banned words (powerful, seamlessly, effortlessly, etc.)
  • Verify new sections render correctly in Mintlify preview

…rce share pages

Documents the new Embeddable and Cloneable visual indicator pills that appear
in list views, helping users identify which assets have sharing enabled at a glance.

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

linear Bot commented May 19, 2026

TSP-1248

@github-actions
Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 3 files (3 with issues, 0 clean)

Scores

Dimension Score What's holding it back
🟡 Consistency 6/10 Title case violations in agent page title/sidebarTitle/H4 headings; "seamlessly" (banned word); "Clonable" vs "Cloneable" across pages; lowercase "agent" on lines 19–20 of agent page inconsistent with capitalized "Agent" everywhere else; bold labels inside callouts.
🟡 Technical clarity 7/10 Copy-pasted iframe URL: Task UI and Clonable Template sections in the agent page point to the exact same demo src. Embed section in the tool page duplicates sharable-link bullet list verbatim. Raw URL on agent page line 108.
🟢 Non-technical clarity 9/10 Content is clear and well-scoped. The public-URL/credits warnings are genuinely helpful. Minor: the workforce overview sentence restates itself.
🟡 Structure 7/10 Workforce's step-by-step list should be a <Steps> component. Bold labels inside <Warning> and <Info> callouts violate CLAUDE.md component rules.

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

Overall vibe: The sharing-labels addition is a useful, coherent feature across all three pages, and the public-access warnings are well-placed. But the agent page has two notable bugs (copy-pasted iframe URL, banned word) and the title/sidebarTitle are in title case — those need fixes before merging. The tool page's embed section also silently repeats the wrong bullet list.

🔧 Issues (14)
  • build/agents/share-your-agent.mdx:2 — Title "Share Your Agent" is title case; sentence case required: "Share your Agent"
  • build/agents/share-your-agent.mdx:3 — sidebarTitle "Share Your Agent""Share your Agent"
  • build/agents/share-your-agent.mdx:4 — description uses lowercase "agent" ("share your agent") while the tool and workforce descriptions capitalize their respective product names; align for consistency: "share your Agent"
  • build/agents/share-your-agent.mdx:22## Clonable Template## Clonable template ("Template" is not a proper noun)
  • build/agents/share-your-agent.mdx:19–20"agent" lowercase in both Embeddable and Cloneable pill descriptions; the rest of the page uses "Agent" (capitalized as a product feature); update to match
  • build/agents/share-your-agent.mdx:27 vs :92Copy-paste bug: the Task UI iframe (line 92) has the exact same src URL as the Clonable Template iframe (line 27): cma29kkqd26vk13m0oed5ldml. Task UI should point to its own demo recording.
  • build/agents/share-your-agent.mdx:49#### Developer Notes#### Developer notes (sentence case)
  • build/agents/share-your-agent.mdx:64–66<Warning> opens with a bold label **User Level Authentication is not supported in embedded chat widgets.**; CLAUDE.md prohibits bold labels inside callouts. Remove the bold label and fold the content into the plain paragraph that follows, or promote the label to a #### heading above the callout.
  • build/agents/share-your-agent.mdx:68#### Developer Notes#### Developer notes (sentence case)
  • build/agents/share-your-agent.mdx:106"seamlessly" is a banned word; rephrase: e.g. "The SDK supports modern frameworks and runtimes including…"
  • build/agents/share-your-agent.mdx:108 — Raw URL (https://github.com/RelevanceAI/relevance-js-sdk); use a markdown link: [RelevanceAI/relevance-js-sdk](https://github.com/RelevanceAI/relevance-js-sdk)
  • build/tools/share-your-tool.mdx:65–69 — The "Embed your Tool" section says "When sharing your Tool as a sharable link, you can select:" and then lists identical bullet points to the Sharable link section above. The embed section should describe embed-specific options (or note that the same display options apply), not silently copy the sharable-link content.
  • build/workforces/share-your-workforce.mdx:11–13<Info> callout opens with a bold label **Enterprise customers:**; CLAUDE.md prohibits bold labels inside callouts. Remove the bold and open the callout with the sentence directly, or split into a <Note> that starts with the plain text.
  • Across pages — "Clonable" (agent page, e.g. line 22) vs "Cloneable" (tool page line 71, workforce page line 26) for the same product feature. Standardize on one spelling throughout all three pages.
🧩 Component suggestions (1)
  • build/workforces/share-your-workforce.mdx:35–39 — The five-step procedure after the demo video is a plain numbered markdown list. CLAUDE.md recommends <Steps> for sequential procedures. Wrapping these in <Steps> would add visual progress indicators and match how other how-to pages in this repo handle step sequences.
⚠️ Contradictions (1)
  • build/agents/share-your-agent.mdx:19 says the Embeddable pill appears when "an embed option (Chat UI, Chat Widget, or Task UI) is enabled." build/tools/share-your-tool.mdx:22 says it appears when "a sharable link or embed is enabled" — meaning a non-embed sharable link also triggers the Embeddable label on the tool page. If this reflects a real product difference (tools and agents have different sharing models), add a sentence to each page clarifying why; if it's a copy-paste oversight, align the definitions.
🔋 Credit usage
Item Count
Files reviewed 3
Context pages read 3
Total lines processed ~484

Files read: build/agents/share-your-agent.mdx (125 lines), build/tools/share-your-tool.mdx (75 lines), build/workforces/share-your-workforce.mdx (46 lines), build/agents/create-an-agent.mdx (91 lines), build/tools/create-a-tool.mdx (102 lines), build/workforces/create-a-workforce.mdx (45 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.

1 participant