Skip to content

docs(TSP-1416, TSP-1481): add command palette tip to the builder intro - #827

Merged
jordanc-relevanceai merged 3 commits into
mainfrom
TSP-1481/docs-update
Nov 5, 2026
Merged

jordanc-relevanceai merged 3 commits into
mainfrom
TSP-1481/docs-update

Conversation

@claude

@claude claude Bot commented Sep 22, 2026 •

Copy link
Copy Markdown

Summary

The command palette is a shortcut, so it gets a tip rather than its own page.

  • build/introduction: added a tip that Cmd+K / Ctrl+K searches across Relevance: pages, settings, agents, tools, workforces, knowledge tables and Invent chats, plus project switching and quick actions.
  • switch-projects: added a "Using the command palette" subsection. The two Supademo embeds now use the standard snippet so the lint passes.
  • Chat intro keyboard shortcuts FAQ: notes that Cmd+K in the builder opens the command palette, which searches pages, resources and projects.

No new page, so docs.json and build/meta.json are unchanged from main.

Checked against relevance-api-node

  • The palette opens for everyone. The cmd-k-spotlight flag was removed in relevance-api-node#19401.
  • Project search covers all of the user's projects, including other regions.
  • The tip leaves out "Ask Invent" (only shown when Invent is available) and the "Create new tool" label (users on the IA v2 shell see "workflow").

Sources

🤖 Generated with Claude Code

@claude claude Bot added the docs-drafter Documentation drafted by Claude label Sep 22, 2026
@vercel

vercel Bot commented Sep 22, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
relevance-docs Ready Ready Preview Nov 5, 2026 1:09am UTC

Request Review

@linear

linear Bot commented Sep 22, 2026 •

Copy link
Copy Markdown

TSP-1481

TSP-1416

Ports the closed #793 page onto the Fumadocs site at build/command-palette
and corrects it against current relevance-api-node: the cmd-k-spotlight
flag is gone, command labels match the code, number-key selection and
same-page landing for resource pages are removed, and the empty-query view
is described as the Recent list it is. Folds in Invent chat search from
relevance-api-node#18551.

Links the page from the project-switching page and the Chat keyboard
shortcuts FAQ, and normalizes the two Supademo embeds there to the
standard snippet so the lint check passes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@jordanc-relevanceai jordanc-relevanceai changed the title docs(0e9e4970-e1a4-4efc-9bb2-ea095590b3cd): add Invent chat conversations to command palette resource search docs(TSP-1416, TSP-1481): add Builder command palette page, with Invent chat search Oct 9, 2026
@jordanc-relevanceai
jordanc-relevanceai changed the base branch from docs/TSP-1416 to main October 9, 2026 03:20
@mintlify

mintlify Bot commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
relevanceai 🟢 Ready View Preview Nov 5, 2026, 1:07 AM

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

The palette is a shortcut, so a tip on the builder intro covers it.
Keeps the project-switching note and the Chat FAQ line, with links
pointed away from the removed page.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@jordanc-relevanceai jordanc-relevanceai changed the title docs(TSP-1416, TSP-1481): add Builder command palette page, with Invent chat search docs(TSP-1416, TSP-1481): add command palette tip to the builder intro Nov 3, 2026
@github-actions

github-actions Bot commented Nov 3, 2026

Copy link
Copy Markdown
Contributor

🎯 Vibe check

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

Scores

Dimension Score What's holding it back
🟡 Consistency 7/10 Product terms (Agents, Tools, Workforces, Knowledge) are lowercase in build/introduction.mdx throughout the Steps body copy, even though the Step titles capitalize them correctly. Also: the keyboard shortcut for Chat lists "(Windows)" in two places while the Builder version of the same shortcut correctly says "(Windows/Linux)".
🟡 Technical clarity 8/10 Anthropic provider row for .md files reads .md — read (limited) only — awkward construction that makes the limitation unclear. Everything else is precise.
🟢 Non-technical clarity 9/10 All three pages are concise and well-scoped. No jargon drops, no orphaned concepts.
🟡 Structure 8/10 <Steps> wraps the "How it all fits together" section in build/introduction.mdx, but Agents/Tools/Workforces/Knowledge are parallel components — not an ordered procedure. CardGroup for file extension lists in chat/introduction.mdx is reference data dressed up as navigation.

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

✨ Overall vibe: Solid PR — the content is accurate, readable, and well-structured at the macro level. The main drag is a consistent capitalization blind spot in build/introduction.mdx: the Step titles capitalize Agents, Tools, Workforces, and Knowledge correctly, but the body text inside each step doesn't, which reads as an editorial gap rather than an intentional style choice.

🔧 Issues (9)
  • site/content/docs/build/introduction.mdx:9 — "agents, tools, workforces, and knowledge" → "Agents, Tools, Workforces, and Knowledge" (all four are Relevance AI product features in this context)
  • site/content/docs/build/introduction.mdx:11 — "your agents directly" → "your Agents directly"
  • site/content/docs/build/introduction.mdx:37 — link text [agents] → [Agents]; "your tools and knowledge" → "your Tools and Knowledge"
  • site/content/docs/build/introduction.mdx:39 — link text [tools] → [Tools]; "your agents can do" → "your Agents can do"
  • site/content/docs/build/introduction.mdx:43 — "multiple agents" → "multiple Agents"; link text [workforce] → [Workforce]
  • site/content/docs/build/introduction.mdx:47 — link text [knowledge] → [Knowledge]; "agents have access" → "Agents have access"
  • site/content/docs/admin/project-management/switch-projects.mdx:20 — "tools, agents, and resources available in that project" → "Tools, Agents, and resources available in that project"
  • site/content/docs/admin/project-management/switch-projects.mdx:38 — (Windows) in the Tip → (Windows/Linux) — the Chat section's Tip omits Linux, contradicting the Builder section on line 24 of the same file (and build/introduction.mdx:18) which both correctly note Windows/Linux
  • site/content/docs/get-started/chat/introduction.mdx:106 — .md — read (limited) only is awkward; suggest .md — limited read (create/export available on request) to match the pattern on the other .md rows
🧩 Component suggestions (2)
  • site/content/docs/get-started/chat/introduction.mdx:49–64 — <CardGroup> wraps four Cards whose content is pure file extension lists. CLAUDE.md says CardGroup isn't appropriate for technical reference lists. A table works better here — one row per category (Documents, Images, Media, Archives), extensions in the second column. The Media card currently uses bold labels (**Audio:**, **Video:**) inside a Card body, which is especially awkward. A simple table would make the whole section scannable at a glance.

  • site/content/docs/build/introduction.mdx:35–48 — <Steps> gives the "How it all fits together" section a numbered 1–4 order that implies a build sequence, but these four components (Agents, Tools, Workforces, Knowledge) aren't ordered steps — they're parallel building blocks. A <CardGroup cols={2}> with icons (matching the "Choose how to build" CardGroup directly below) would represent them as equal components without implying an order.

⚠️ Contradictions (1)
  • site/content/docs/admin/project-management/switch-projects.mdx:24 and site/content/docs/build/introduction.mdx:18 both document the shortcut as Cmd+K (Mac) / Ctrl+K (Windows/Linux). But switch-projects.mdx:38 (inside the Chat section Tip) and site/content/docs/get-started/chat/introduction.mdx:175 (FAQ accordion) both say just "(Windows)" for the same Chat shortcut. The Linux coverage claim conflicts across pages — pick one scope and apply it consistently.
🔋 Credit usage
Item Count
Files reviewed 3
Context pages read 2
Total lines processed ~495

Files read: switch-projects.mdx (42 lines), build/introduction.mdx (66 lines), get-started/chat/introduction.mdx (199 lines), get-started/chat/using-agents.mdx (75 lines), admin/project-management/add-members.mdx (113 lines)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@jordanc-relevanceai
jordanc-relevanceai merged commit ed5d1d8 into main Nov 5, 2026
8 of 11 checks passed
@github-actions

github-actions Bot commented Nov 5, 2026

Copy link
Copy Markdown
Contributor

🎯 Vibe check

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

Scores

Dimension Score What's holding it back
🟡 Consistency 7/10 Product term capitalization slips across two files: "agents, tools, workforces, and knowledge" (lowercase) in build/introduction.mdx, and "agents" in switch-projects.mdx.
🟡 Technical clarity 7/10 LLM-selection FAQ in chat/introduction.mdx describes a "cog icon" workflow that doesn't match the main Selecting an LLM section (video only), and may be stale UI. Anthropic accordion has an unexplained "(limited)" qualifier on .md support absent from the other provider accordions.
🟢 Non-technical clarity 9/10 All three pages are readable and well-scoped. No jargon dumps, no marketing fluff.
🟡 Structure 7/10 <Steps> is used in build/introduction.mdx for four parallel feature descriptions, not a sequential procedure — wrong component. chat/introduction.mdx ends with an FAQ and no closing CTA despite being a concept/overview page.

Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5. Scores are a single overall judgment about the whole PR — not per file.

✨ Overall vibe: Three focused, well-written pages that do what they say they do. The main drag is a consistent pattern of lowercase product terms (agents, tools, workforces, knowledge) across two files — easy to fix but it repeats several times. The <Steps> component used for a parallel feature overview in build/introduction.mdx is the most significant structural misstep.

🔧 Issues (7)
  • site/content/docs/build/introduction.mdx:9 — "agents, tools, workforces, and knowledge" → "Agents, Tools, Workforces, and Knowledge" (all four are Relevance AI product features)
  • site/content/docs/build/introduction.mdx:11 — "interact with your agents directly. You can @ mention agents, use multiple agents in a single conversation, and give your team access to your agents" → all four instances of "agents" → "Agents"
  • site/content/docs/build/introduction.mdx:18 — Tip text: "agents, tools, workforces, knowledge tables" and "creating a new agent" → "Agents, Tools, Workforces, Knowledge tables" and "creating a new Agent"
  • site/content/docs/admin/project-management/switch-projects.mdx:20 — "tools, agents, and resources" → "Tools, Agents, and resources"
  • site/content/docs/admin/project-management/switch-projects.mdx:41 — "agents available in that project" → "Agents available in that project"
  • site/content/docs/get-started/chat/introduction.mdx:106 — Anthropic accordion: .md — read (limited) only — the "(limited)" qualifier is absent from the OpenAI and Gemini accordions for the same entry. If Anthropic genuinely has more restricted .md support, explain what the limitation is; if it's a copy error, remove it.
  • site/content/docs/get-started/chat/introduction.mdx:160–164 — FAQ for "Can I use different LLMs in Chat?" gives step-by-step instructions ("click on the cog icon in the top right") that don't match the main "Selecting an LLM" section above (line 31–37), which only shows a video with no text steps. The steps could be stale UI. Either update them to match the current UI or replace the FAQ answer with a cross-reference: "Yes — see Selecting an LLM above."
🧩 Component suggestions (3)
  • site/content/docs/build/introduction.mdx:35–48 — <Steps> is used for four parallel feature descriptions (Agents, Tools, Workforces, Knowledge). These are not sequential steps — Mintlify renders <Steps> with numbered progression indicators (1, 2, 3, 4), implying the reader does them in order. Swap for a <CardGroup cols={2}> with icons, matching the pattern already used in the "Choose how to build" section directly below. Each card keeps its current icon, title, and body text.
  • site/content/docs/admin/project-management/switch-projects.mdx:17–18 and 34–35 — Plain numbered markdown lists are used for the sequential 2-step procedures ("1. Click … 2. Select …"). These are exactly the kind of sequential steps <Steps> is designed for. The upgrade is minor but consistent with how the rest of the docs handle procedural walkthroughs.
  • site/content/docs/get-started/chat/introduction.mdx:170–172 — **Important limitations:** is used as an inline section header inside accordion body text. Use a <Warning> callout wrapping the two limitation sentences instead — these are genuine access restrictions (project-scoped history, no cross-user visibility) that readers should notice, and the bold-label approach doesn't flag them clearly enough.
🏗️ Page structure (1)
  • site/content/docs/get-started/chat/introduction.mdx — No closing CTA. As a concept/overview page, it should end with somewhere to go. Add a ## What's next? with links to /get-started/chat/using-agents (how to mention Agents in a conversation) and /build/agents/create-an-agent (how to build the Agents you'll use in Chat).
🔋 Credit usage
Item Count
Files reviewed 3
Context pages read 2
Total lines processed ~742

Files read: switch-projects.mdx (42 lines), build/introduction.mdx (66 lines), chat/introduction.mdx (199 lines), get-started/chat/using-agents.mdx (75 lines), build/invent/invent.mdx (360 lines)

This branch was successfully deployed

2 active deployments
Preview — c494fba5 Deployed Nov 5, 2026 by vercel[bot]
staging — c494fba5 Deployed Nov 5, 2026 by mintlify[bot]
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