docs: knowledge section update — consolidated Tool steps + catalog sync

[jordanc-relevanceai]

What this does

Restructures the Knowledge section of the docs, with the main focus on the Knowledge Tool steps page.

Knowledge Tool steps

• Consolidated the seven separate per-step pages (previously under build/tools/tool-steps/knowledge/) into a single tabbed page in the Knowledge section, grouped as Writing knowledge and Searching and reading knowledge.
• Synced every step against the live transformations catalog:
  • removed Advanced knowledge search (plain) — it no longer exists as a Tool step
  • added Upsert knowledge (heavily used, was undocumented)
  • corrected Knowledge search fields (dropped the hidden Vector field, added Use exact search) and trued up field labels
• Folded the repeated per-tab variable notes and FAQs into single shared sections.
• Removed the Supademo embeds for now.

Styling

• Wrapped the step tabs in the guides' path-picker treatment, then fixed it for this use: scroll-safe (no clipped first/last tab), softer glow that no longer hits a hard rectangle, flush symmetric edges, and a white active-tab icon (was blending into the purple pill). style.css only; guides share the class and are unaffected (no overflow there).

Links and redirects

• Tab ids preserve the old anchors; old /build/tools/tool-steps/knowledge/* URLs redirect to the matching tab.
• Snippet cards and cross-links (core concepts, few-shot prompting) updated.

Note: this branch also carries broader Knowledge-section edits (create-knowledge, integrated sources, snippets, removed legacy pages) that were already in progress.

Preview

Run locally and check /build/knowledge/knowledge-tool-steps in both light and dark.

🤖 Generated with Claude Code

[mintlify]

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

Project	Status	Preview	Updated (UTC)
relevanceai	🟢 Ready	View Preview	Jun 10, 2026, 4:21 AM

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

[github-actions]

🎯 Vibe check

Reviewed: 15 files (8 with issues, 7 clean) — plus 12 files deleted in the PR (old individual tool-step pages + redundant concept pages), confirmed replaced by redirects in docs.json.

Scores

	Dimension	Score	What's holding it back
🟡	Consistency	6/10	"Sharepoint" misspelled throughout the SharePoint page (6+ instances); single-quotes around UI elements in all four integrated-source pages instead of bold; 3 sentence-case violations in the core-concepts Knowledge page
🟡	Technical clarity	7/10	Broken link at /build/knowledge/ in few-shot-prompting; inactive-table-deletion.mdx is orphaned from sidebar navigation; direct email address in inactive-table-deletion violates the CLAUDE.md email policy
🟢	Non-technical clarity	9/10	Well-structured; the "think of it as your agent's reference library" analogy is good. The few-shot-prompting page has legacy roughness but the core Knowledge pages are clean.
🟡	Structure	7/10	inactive-table-deletion.mdx not in docs.json nav (orphaned page). One <Tip> callout in few-shot-prompting violates the single-paragraph rule.

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

✨ Overall vibe: Solid consolidation work — a dozen individual tool-step pages and redundant concept files are collapsed into a well-organized tabbed reference with proper redirects, which is a real improvement to navigability. The main issues are a systematic branding error on the SharePoint page, formatting inconsistency in the integrated-source step lists, and a handful of sentence-case slips on the concepts page. None are blocking but there's a tidy-up pass needed.

🔧 Issues (11)

• get-started/core-concepts/knowledge.mdx:33 — ## How Knowledge Works → ## How Knowledge works (sentence case: "Works" should be lowercase)
• get-started/core-concepts/knowledge.mdx:96 — Card title="Create a Knowledge Base" → title="Create a Knowledge base" ("Base" should be lowercase in sentence case)
• get-started/core-concepts/knowledge.mdx:101 — Card title="Connect Integrations" → title="Connect integrations" ("Integrations" should be lowercase)
• build/knowledge/integrated-knowledge-sources/sharepoint.mdx:1–4 — Title, sidebarTitle, and description all spell it "Sharepoint" — the official brand name is SharePoint (capital P). Also the title "Sharepoint as a Knowledge Source" has "Source" capitalized — sentence case: "SharePoint as a Knowledge source".
• build/knowledge/integrated-knowledge-sources/sharepoint.mdx:7 — Alt text "Sharepoint Knowledge Pn" — fix brand name and "Pn" looks like a truncated typo.
• build/knowledge/integrated-knowledge-sources/sharepoint.mdx:22–26,32–33 — "Sharepoint" → "SharePoint" throughout the steps and the FAQ accordion title.
• build/knowledge/integrated-knowledge-sources/confluence.mdx:21–26 — Step list uses single quotes around UI element names (Click 'Knowledge', Click 'Add Confluence') instead of bold. Every other how-to page in this PR uses bold (Click **Knowledge**). Same issue in google-drive.mdx:22–28 and notion.mdx:20–25.
• build/knowledge/inactive-table-deletion.mdx:28 — References support@relevanceai.com inline. CLAUDE.md: "Always link to the support contact page (/get-started/support) rather than referencing specific email addresses." The sentence "This email comes from support@relevanceai.com and is a legitimate notification" should be reworded to avoid the address — e.g. "This email is sent from a Relevance AI support address and is a legitimate notification."
• example-use-cases/few-shot-prompting.mdx:61 — [best practice to prepare my CSV data](/build/knowledge/) — no index page exists at /build/knowledge/. This link is broken and should point to /build/knowledge/create-knowledge or be removed.
• build/knowledge/knowledge-tool-steps.mdx:16 — "useful for capturing and storing data dynamically as a Tool or agent runs" — "agent" should be "Agent" (Relevance AI product) since "Tool" is capitalized in the same phrase.

🧩 Component suggestions (1)

• example-use-cases/few-shot-prompting.mdx:31–37 — <Tip> contains a bold heading label ("Don't take system prompts for granted"), multiple sentences, and an inline code example. CLAUDE.md: callouts must be a single short paragraph with no multi-line content or bold labels. This content should be lifted out as a ### Don't take system prompts for granted section with prose underneath and the code example in a fenced block.

🏗️ Page structure (1)

• build/knowledge/inactive-table-deletion.mdx — This page is not included in the docs.json navigation. It's accessible only via a <Note> link in delete-knowledge.mdx. CLAUDE.md: "No orphaned pages (everything is linked from navigation)." Add it to the Knowledge group in docs.json, likely after delete-knowledge or as a nested page under it.

✅ Clean files (7)

_snippets/components/integrations/knowledge-tool-steps.mdx, build/knowledge/create-knowledge.mdx, build/knowledge/delete-knowledge.mdx, build/knowledge/enrich-with-tool.mdx, build/knowledge/use-snippets-for-quick-access.mdx, style.css, docs.json (redirects look correct)

🔋 Credit usage

Item	Count
Files reviewed	15
Context pages read	2 (docs.json navigation section, sibling directory listing)
Total lines processed	~1,150

Files read: _snippets/components/integrations/knowledge-tool-steps.mdx (26 lines), build/knowledge/create-knowledge.mdx (70 lines), build/knowledge/delete-knowledge.mdx (38 lines), build/knowledge/enrich-with-tool.mdx (86 lines), build/knowledge/inactive-table-deletion.mdx (77 lines), build/knowledge/integrated-knowledge-sources/confluence.mdx (38 lines), build/knowledge/integrated-knowledge-sources/google-drive.mdx (42 lines), build/knowledge/integrated-knowledge-sources/notion.mdx (36 lines), build/knowledge/integrated-knowledge-sources/sharepoint.mdx (35 lines), build/knowledge/knowledge-tool-steps.mdx (409 lines), build/knowledge/use-snippets-for-quick-access.mdx (43 lines), example-use-cases/few-shot-prompting.mdx (113 lines), get-started/core-concepts/knowledge.mdx (114 lines), style.css (~392 lines), docs.json (selected sections)

[github-actions]

🎯 Vibe check

Reviewed: 14 files (7 with issues, 7 clean) — plus 13 deleted files confirmed removed and redirected via docs.json

Scores

	Dimension	Score	What's holding it back
🔴	Consistency	5/10	"Sharepoint" (wrong product name) used ~10 times throughout sharepoint.mdx; "Source" capitalized in 4 page titles; "## How Knowledge Works" heading; single-quote UI references across all 4 integrated-source pages
🟡	Technical clarity	7/10	All 4 integrated-source pages use single quotes instead of bold for UI element names; notion.mdx step 4 says "files" but Notion uses pages/databases; few-shot-prompting.mdx has a likely-broken link
🟢	Non-technical clarity	9/10	Good analogies ("reference library"), well-layered complexity, clean intro before instructions. few-shot-prompting.mdx is old and rough but within scope.
🟡	Structure	7/10	inactive-table-deletion.mdx is not in docs.json navigation (orphan reachable only by link); the page also uses future tense for an event that passed May 4, 2026, contradicting the past-tense Note in delete-knowledge.mdx

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

✨ Overall vibe: The consolidation work is solid — pulling eight individual tool-step pages into one tabbed reference, wiring up redirects, and writing clean prose throughout. The main drag is the sharepoint.mdx file, which misspells the product name on almost every line, plus consistent single-quote-instead-of-bold UI references across all four integrated-source pages that will confuse readers trying to follow the steps.

🔧 Issues (16)

Sharepoint misspelling — systemic across sharepoint.mdx

• build/knowledge/integrated-knowledge-sources/sharepoint.mdx:1 — title: "Sharepoint as a Knowledge Source" → "SharePoint as a Knowledge source" (product name is SharePoint, and "Source" is not a proper noun)
• build/knowledge/integrated-knowledge-sources/sharepoint.mdx:3 — sidebarTitle: "Sharepoint" → "SharePoint"
• build/knowledge/integrated-knowledge-sources/sharepoint.mdx:4 — "Use Sharepoint as a source..." → "SharePoint"
• build/knowledge/integrated-knowledge-sources/sharepoint.mdx:9,11,15,22,23,24,31 — "Sharepoint" appears seven more times throughout the body, heading, and FAQ accordion title; all should be "SharePoint". The one correct instance at line 32 ("changes made to those files in SharePoint") confirms the author knows the right spelling.

Page title sentence case — four files

• build/knowledge/integrated-knowledge-sources/google-drive.mdx:1 — title: "Google Drive as a Knowledge Source" → "Google Drive as a Knowledge source" ("Source" is not a proper noun)
• build/knowledge/integrated-knowledge-sources/notion.mdx:1 — title: "Notion as a Knowledge Source" → "Notion as a Knowledge source"
• build/knowledge/integrated-knowledge-sources/confluence.mdx:1 — title: "Confluence as a Knowledge Source" → "Confluence as a Knowledge source"

Heading sentence case

• get-started/core-concepts/knowledge.mdx:32 — ## How Knowledge Works → ## How Knowledge works ("Works" is not a proper noun)

UI element names — single quotes instead of bold, four files

• build/knowledge/integrated-knowledge-sources/confluence.mdx:21-25 — Click 'Knowledge', Click 'Add Confluence', click 'Create' → Click **Knowledge**, Click **Add Confluence**, click **Create**
• build/knowledge/integrated-knowledge-sources/google-drive.mdx:21-27 — same pattern: 'Knowledge', 'Add Google Drive', 'Create' → bold
• build/knowledge/integrated-knowledge-sources/notion.mdx:19-24 — 'Knowledge', 'Add Notion', 'Create' → bold
• build/knowledge/integrated-knowledge-sources/sharepoint.mdx:20-25 — 'Knowledge', 'Add Sharepoint', 'Create' → bold (fix the product name too)

Terminology inconsistency

• build/knowledge/integrated-knowledge-sources/notion.mdx:23 — Step 4 says "Select the Notion files you wish to have the Agent read" but Notion uses pages and databases, not files. The FAQ at line 30 of the same file correctly says "You can select both Notion pages and databases." Change step 4 to "Select the Notion pages or databases you wish to have the Agent read."

Few-shot-prompting link and spelling

• example-use-cases/few-shot-prompting.mdx:62 — [best practice to prepare my CSV data](/build/knowledge/) — /build/knowledge/ is a directory path with no target page; this likely 404s or lands somewhere unrelated. Either link to a specific page or remove the link.
• example-use-cases/few-shot-prompting.mdx:110 — "out-dated" → "outdated" (one word)

Tense — inactive table deletion

• build/knowledge/inactive-table-deletion.mdx:8,11,28,37,38 — The event date was May 4, 2026; today is June 11, 2026. The page still reads "Relevance AI will perform", "You will receive an email", "tables will not be deleted", etc. All future-tense references to the event should be past tense.

🧩 Component suggestions (2)

• _snippets/components/integrations/knowledge-tool-steps.mdx:1 — uses <Columns cols={2}> to lay out the cards. <Columns> is not a standard Mintlify built-in and doesn't appear elsewhere in the reviewed files; <CardGroup cols={2}> is the documented equivalent. Verify this renders as expected in production — if not, swap for <CardGroup cols={2}>.

• build/knowledge/knowledge-tool-steps.mdx:12,235 — the <Tabs> blocks are wrapped in <div className="path-picker">, a custom class defined in style.css added in this same PR. This is not a Mintlify component and won't be visible in the Mintlify preview without the custom CSS. Confirm the CSS is correctly loaded in the production build and the tab styling renders as intended.

🏗️ Page structure (1)

• build/knowledge/inactive-table-deletion.mdx — the page exists and is linked from delete-knowledge.mdx, but it has no entry in docs.json navigation. Per CLAUDE.md: "No orphaned pages (everything is linked from navigation)." Either add it under the Knowledge group in docs.json (for example, as a child of delete-knowledge) or confirm this is intentional and the link-only access is sufficient.

⚠️ Contradictions (1)

• build/knowledge/inactive-table-deletion.mdx vs build/knowledge/delete-knowledge.mdx:21-23 — delete-knowledge.mdx uses past tense: "Knowledge tables on long-inactive, non-Enterprise accounts were subject to a one-time cleanup... It was a single past event." But inactive-table-deletion.mdx still uses future tense throughout: "Relevance AI will perform a one-time deletion", "tables will not be deleted", etc. The event was May 4, 2026; inactive-table-deletion.mdx needs to be updated to past tense to match.

✅ Clean files (7)

build/knowledge/create-knowledge.mdx, build/knowledge/delete-knowledge.mdx, build/knowledge/enrich-with-tool.mdx, build/knowledge/knowledge-tool-steps.mdx, build/knowledge/use-snippets-for-quick-access.mdx, get-started/core-concepts/knowledge.mdx (one heading case issue aside, overall excellent), style.css

Deleted files and their redirects in docs.json are all accounted for and correctly wired up.

🔋 Credit usage

Item	Count
Files reviewed	14
Deleted files confirmed	13
Context pages read	2 (docs.json navigation, style.css)
Total lines processed	~1,050

Files read: _snippets/components/integrations/knowledge-tool-steps.mdx (26 lines), build/knowledge/create-knowledge.mdx (70 lines), build/knowledge/delete-knowledge.mdx (37 lines), build/knowledge/enrich-with-tool.mdx (86 lines), build/knowledge/inactive-table-deletion.mdx (77 lines), build/knowledge/integrated-knowledge-sources/confluence.mdx (38 lines), build/knowledge/integrated-knowledge-sources/google-drive.mdx (43 lines), build/knowledge/integrated-knowledge-sources/notion.mdx (35 lines), build/knowledge/integrated-knowledge-sources/sharepoint.mdx (34 lines), build/knowledge/knowledge-tool-steps.mdx (409 lines), build/knowledge/use-snippets-for-quick-access.mdx (43 lines), example-use-cases/few-shot-prompting.mdx (113 lines), get-started/core-concepts/knowledge.mdx (114 lines), style.css (392 lines), docs.json (selected lines via grep)

[alexrelevanceai]

Where did this page come from? Was it hidden before?