docs(522754a3-5b91-4602-9737-710452808b8b): add Academy CTAs to docs - #813
Conversation
Strategic placements in get-started/introduction, build/introduction, quick-start-guide, create-an-agent, and create-a-tool. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
🎯 Vibe checkReviewed: 5 files (4 with issues, 1 clean) Scores
Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5. ✨ Overall vibe: The how-to guides ( 🔧 Issues (25)
🧩 Component suggestions (2)
🏗️ Page structure (3)
✅ Clean files (1)
🔋 Credit usage
Files read: |
…ominent per reviewer feedback - Wrap plain-text Academy links in <Tip> callouts in create-an-agent.mdx and create-a-tool.mdx so they stand out at the end of the What's next sections - Move the floating Academy card in introduction.mdx into the Choose how to build CardGroup as a third option alongside Invent and Build directly Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Addressed the three feedback points:
|
|
Can we also add the tip to workforces and knowledge as well then? also, on things like Evals |
…emove card from build intro Per reviewer feedback: remove Academy card from the build introduction CardGroup and add Academy tip callouts to workforces, knowledge, and evals pages. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Addressed reviewer feedback with two changes: Removed Academy card from build/introduction.mdx Added Academy
|
🎯 Vibe checkReviewed: 5 files (5 with issues, 0 clean) Scores
Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5. ✨ Overall vibe: The build-side pages ( 🔧 Issues (17)
🧩 Component suggestions (2)
🏗️ Page structure (2)
🔋 Credit usage
Files read: |
🎯 Vibe checkReviewed: 7 files (4 with issues, 3 clean) Scores
Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5. ✨ Overall vibe: The create-an-agent, create-a-workforce, create-a-tool, and quick-start-guide pages are clean — good UI specificity, correct product-term capitalization, and tight structure. The two pages dragging down the PR are 🔧 Issues (28)Banned words
Sentence case — headings
Sentence case — Card and Accordion titles
Product term capitalization
🧩 Component suggestions (2)
🏗️ Page structure (3)
✅ Clean files (3)
🔋 Credit usage
Files read: |
|
Academy currently teaches users about Agents, Tools, Knowledge, Triggers. So please make sure it's called out as a tip on each page if not already. Make sure the academy is also mentioned on more general build pages as well. This is a final passthrough, so if you've already done this, then that's no problem |
…lumns and add triggers Academy tip Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Final passthrough complete. Two changes in this push:
|
🎯 Vibe checkReviewed: 8 files (6 with issues, 2 clean) Scores
Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5. ✨ Overall vibe: 🔧 Issues (20)Banned word
Heading sentence case —
Card titles —
Accordion titles —
Heading sentence case —
UI element formatting —
Internal link format —
Product term capitalization —
Product term capitalization —
Product term capitalization —
🧩 Component suggestions (3)
🏗️ Page structure (4)
✅ Clean files (2)
🔋 Credit usage
Files read: |
|
instead of tips, can we make them info blocks? |
… Tip to Info callouts Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Done — converted all Academy CTA callouts from |
🎯 Vibe checkReviewed: 8 files (5 with issues, 3 clean) Scores
Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5. Scores are a single overall judgment about the whole PR — not per file. ✨ Overall vibe: Three files ( 🔧 Issues (30)Banned words
Heading sentence case —
Heading sentence case —
Internal links —
UI element formatting —
Frontmatter conflict —
Cross-page capitalization inconsistency
🧩 Component suggestions (1)
🏗️ Page structure (4)
|
| Item | Count |
|---|---|
| Files reviewed | 8 |
| Context pages read | 3 |
| Total lines processed | ~1,492 |
Files read: build/agents/build-your-agent/triggers.mdx (126 lines), build/agents/create-an-agent.mdx (96 lines), build/agents/evals/introduction.mdx (109 lines), build/knowledge/create-knowledge.mdx (197 lines), build/tools/create-a-tool.mdx (107 lines), build/workforces/create-a-workforce.mdx (50 lines), get-started/introduction.mdx (169 lines), get-started/quick-start-guide.mdx (141 lines), get-started/core-concepts/agents.mdx (230 lines), get-started/core-concepts/knowledge.mdx (110 lines), build/agents/build-your-agent/agent-triggers/scheduled-triggers.mdx (159 lines)
|
You changed all callouts to that. It should only be academy ones. The other ones on the page should stay the same. Please also make sure the info one is the blue info bubble, not the grey one like it is now. |
…uts to Tip blocks Only Academy CTAs (linking to relevanceai.com/academy) should be Info blocks. General tips in create-an-agent and create-a-workforce reverted to Tip. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Fixed the callout types per review feedback. What changed:
All other files were already correct — only Academy callouts (those linking to relevanceai.com/academy) are |
🎯 Vibe checkReviewed: 8 files (6 with issues, 2 clean) Scores
Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5. ✨ Overall vibe: The how-to pages ( 🔧 Issues (22)Banned word
Heading case —
Card title case —
Heading case —
Absolute URLs —
Product term capitalization —
Product term capitalization —
Product term capitalization —
🧩 Component suggestions (1)
🏗️ Page structure (4)
✅ Clean files (2)
🔋 Credit usage
Files read: |
|
Maybe just change the write up of the callout to not mention workforce but just generally mention building on the platform. I also feel that the callouts can be placed better: it shouldn't be at the end, it should be at the start or maybe at the start of build manually section or something. |
…ademy CTAs per PR review Rewrote callout copy to be platform-general (removes workforce-specific mention). Moved callouts from page bottoms to the start of the build- manually/step-by-step section on each page so users see it before they begin. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Actioned all review feedback. Here's what changed: New callout copyAll 6 pages now use the same platform-general copy (no more workforce-specific mention):
Repositioned calloutsEach callout moved from the bottom of the page to earlier in the content flow:
All 6 pages updated in commit afb2c14. |
🎯 Vibe checkReviewed: 8 files (4 with issues, 4 clean) Scores
Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5. ✨ Overall vibe: Four of the eight files ( 🔧 Issues (35)
🧩 Component suggestions (2)
🏗️ Page structure (3)
✅ Clean files (4)
🔋 Credit usage
Files read: |
Summary
get-started/introduction.mdxbuild/introduction.mdxget-started/quick-start-guide.mdxbuild/agents/create-an-agent.mdxbuild/tools/create-a-tool.mdxFive strategic placements — all in high-traffic entry points and "what's next?" sections where users are most likely to want structured learning resources.
Linear: https://linear.app/relevance/issue/522754a3-5b91-4602-9737-710452808b8b/