docs: knowledge section update — consolidated Tool steps + catalog sync by jordanc-relevanceai · Pull Request #664 · RelevanceAI/relevance-docs

jordanc-relevanceai · 2026-06-10T04:19:13Z

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

… catalog Fold the per-step Knowledge Tool step pages into a single tabbed page in the Knowledge section (Writing / Searching and reading groups), and verify every step against the platform's transformations catalog: - remove Advanced knowledge search (plain) — no longer exists as a Tool step - add Upsert knowledge (heavily used, was undocumented) - fix Knowledge search fields: drop hidden Vector field, add Use exact search - true up field labels and the variable-typing guidance Tab ids preserve the old anchors; old /build/tools/tool-steps/knowledge/* URLs redirect to the matching tab. Snippet cards and cross-links updated. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

- remove the Supademo embeds from each step - capitalize the Knowledge product noun in headings, tab titles, and prose - wrap the step tabs in the guides' path-picker styling - fix path-picker for this use: scroll-safe (no clip), softer non-clipped glow, flush symmetric edges, and a white active-tab icon (was blending into the pill) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

mintlify · 2026-06-10T04:19:22Z

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.

- Google Drive: restore the definitive 50MB file-size limit and 15-minute sync interval - Notion: restore the definitive 5-minute sync interval - create-knowledge: give the create flow a step-by-step feel (numbered steps, options nested) - snippets: shorten page title to "Snippets" Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

github-actions · 2026-06-10T06:41:48Z

🎯 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)

- inactive-table-deletion: FAQ heading -> "Frequently asked questions (FAQs)" - notion, sharepoint: replace the non-standard embed wrapper (kebab padding-top: 56.75%) with the standard snippet (paddingTop: '56.25%', purple border, rounded corners) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

github-actions · 2026-06-11T03:58:07Z

🎯 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)

This page is not in docs.json (hidden/retired), so leave it untouched and matching main rather than updating its internal link. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Avoid a redirect-dependent link on the retired page. Points straight at the consolidated Knowledge tool steps page instead of the deleted old path that only resolves via a docs.json redirect. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

github-actions · 2026-07-01T05:16:17Z

🎯 Vibe check

Reviewed: 14 files (7 with issues, 7 clean)

Note on deleted files: 12 files listed as changed are deletions (access-knowledge.mdx, advanced-knowledge-retrieval.mdx, find-and-use-knowledge.mdx, all build/tools/tool-steps/knowledge/ files, and get-started/key-concepts/knowledge.mdx). These no longer exist and can't be reviewed — the deletion itself looks structurally correct given the consolidation into knowledge-tool-steps.mdx.

Non-doc changes: style.css adds the .path-picker CSS class that styles the new tabbed layout in knowledge-tool-steps.mdx. The class is now used in several other guide pages, so the pattern is established — the CSS looks well-scoped and shouldn't affect other pages. docs.json removes the old per-step navigation entries and adds a cleaner Knowledge group hierarchy; the restructure is correct.

Scores

	Dimension	Score	What's holding it back
🟡	Consistency	6/10	"SharePoint" misspelled as "Sharepoint" throughout `sharepoint.mdx`; single-quote UI labels in all four integration pages instead of bold; heading case errors in core concepts; feature name "2M" vs "2m" differs across two pages.
🟡	Technical clarity	7/10	`inactive-table-deletion.mdx` still uses future tense ("will perform") even though the event (May 4, 2026) is now in the past; email address in docs violates CLAUDE.md policy; "Delete knowledge" link text doesn't match the page title.
🟢	Non-technical clarity	8/10	Content is generally clear. Minor: "Yes!" is informal in an FAQ answer.
🟡	Structure	7/10	`inactive-table-deletion.mdx` is not in `docs.json` (orphaned); horizontal rule before its FAQ section is inconsistent with surrounding pages.

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

✨ Overall vibe: The restructuring here is the right call — consolidating 8 separate tool-step pages into one tabbed layout in knowledge-tool-steps.mdx makes the content far more usable, and the new delete-knowledge.mdx and confluence.mdx pages are well-written. The main drag is a cluster of consistency issues: "Sharepoint" vs "SharePoint" is systematic and needs a find-replace, and all four integration pages share the same single-quote-instead-of-bold UI label pattern that doesn't match the standard used elsewhere in this PR.

🔧 Issues (11)

get-started/core-concepts/knowledge.mdx:33 — "## How Knowledge Works" → sentence case: "## How Knowledge works"
get-started/core-concepts/knowledge.mdx:100 — Card title="Create a Knowledge Base" → "Create a Knowledge base" ("Base" isn't a proper noun)
get-started/core-concepts/knowledge.mdx:105 — Card title="Connect Integrations" → "Connect integrations"
build/knowledge/integrated-knowledge-sources/sharepoint.mdx (lines 1, 2, 7, 9, 11, 13, 21–23, 31) — "Sharepoint" is misspelled throughout; Microsoft's product is "SharePoint" (capital P). Only line 32 gets it right. Do a find-replace on the file.
build/knowledge/inactive-table-deletion.mdx:11 — "Relevance AI will perform a one-time deletion" uses future tense, but the event was scheduled for May 4, 2026 — which has passed as of today. Update to past tense throughout the page ("performed", "affected", "received", etc.). The Note in delete-knowledge.mdx already uses past tense ("were subject to", "It was a single past event") so the two pages currently contradict each other.
build/knowledge/inactive-table-deletion.mdx:29 — "support@relevanceai.com" appears inline. CLAUDE.md says to link to /get-started/support rather than hardcoding email addresses. In this context the email is named to reassure readers it's not phishing — consider phrasing like "This email is a legitimate notification from Relevance AI. If you're unsure, contact support." instead.
build/knowledge/create-knowledge.mdx:68 — Link text "Delete knowledge" → "Delete Knowledge" to match the page title.
build/knowledge/integrated-knowledge-sources/confluence.mdx:21–26 — Steps use single quotes for UI elements (Click 'Knowledge', Click 'Add Confluence') instead of bold. All step instructions in this PR's other pages use bold for UI labels (e.g. create-knowledge.mdx: Click **Knowledge**). Apply the same pattern here.
build/knowledge/integrated-knowledge-sources/google-drive.mdx:22–28 — Same single-quote UI label issue (Click 'Knowledge', Click 'Add Google Drive', etc.) → use bold.
build/knowledge/integrated-knowledge-sources/notion.mdx:18–24 — Same single-quote issue. Also: line 30 — "Yes! You can select both Notion pages and databases" → drop the exclamation mark; "Yes. You can select both..." reads as technical docs.
build/knowledge/integrated-knowledge-sources/sharepoint.mdx:20–26 — Same single-quote issue on top of the capitalization problem above.

🏗️ Page structure (2)

build/knowledge/inactive-table-deletion.mdx — The page is not listed anywhere in docs.json. CLAUDE.md requires no orphaned pages. It's reachable via a deep link from delete-knowledge.mdx, but since the event has passed this page arguably should either be added to the nav under delete-knowledge or removed. If keeping it, add "build/knowledge/inactive-table-deletion" as a child of "build/knowledge/delete-knowledge" in docs.json.
build/knowledge/inactive-table-deletion.mdx:44 — The bare --- horizontal rule immediately before the FAQ heading doesn't appear in any other page in this PR. Remove it; the ## Frequently asked questions (FAQs) heading provides sufficient visual separation.

⚠️ Contradictions (2)

build/knowledge/inactive-table-deletion.mdx:11 vs build/knowledge/delete-knowledge.mdx:22 — inactive-table-deletion.mdx uses future tense ("will perform", "you will receive") while delete-knowledge.mdx refers to the same event in past tense ("were subject to", "It was a single past event"). The two pages need to agree. Since the May 4, 2026 date has passed, inactive-table-deletion.mdx should be updated to past tense throughout.
get-started/core-concepts/knowledge.mdx:50 links to "Advanced knowledge search (2M context)" with an uppercase M. In build/knowledge/knowledge-tool-steps.mdx, the same feature is called "Advanced Knowledge search (2m)" everywhere (lowercase m, no "context" in the tab title). Pick one form and use it consistently.

✅ Clean files (7)

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, _snippets/components/integrations/knowledge-tool-steps.mdx, style.css, docs.json

🔋 Credit usage

Item	Count
Files reviewed	14
Context pages read	0
Total lines processed	~1,350

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 (35 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), get-started/core-concepts/knowledge.mdx (114 lines), docs.json (~400 lines read), style.css (392 lines)

/build/knowledge/ has no landing page (404); point at create-knowledge to match the adjacent links. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

github-actions · 2026-07-01T05:22:34Z

🎯 Vibe check

Reviewed: 15 files (7 with issues, 8 clean) — 12 files in the PR list were deleted as part of the consolidation and no longer exist

Non-doc changes: style.css adds .path-picker scoped styles that power the tabbed layout on the new Knowledge Tool steps page, plus minor layout/changelog tweaks. No documentation content is affected. docs.json reorganizes the Knowledge section and adds redirect rules for all removed pages — the redirect coverage looks thorough and all destinations resolve to real pages.

Scores

	Dimension	Score	What's holding it back
🟡	Consistency	6/10	Lowercase `agent`/`agents` used for the Relevance AI product throughout `get-started/core-concepts/knowledge.mdx`; "Sharepoint" misspelled instead of "SharePoint" in nine places across `sharepoint.mdx`; two card titles in the core-concepts page use title case instead of sentence case; single quotes around UI element names across all four integration pages where bold is used everywhere else.
🟡	Technical clarity	7/10	`inactive-table-deletion.mdx` uses future tense for an event that occurred on May 4, 2026 — two months ago. A `<Columns>` component in the snippet file is not standard Mintlify and may not render. One link in `few-shot-prompting.mdx` points to a bare directory path (`/build/knowledge/`) that likely 404s. Confluence integration page gives no sync frequency (Google Drive = 15 min, Notion = 5 min — creates an uneven picture for readers comparing options).
🟡	Non-technical clarity	8/10	The new `get-started/core-concepts/knowledge.mdx` overview page is well-structured and the "reference library" analogy works well for a first-time reader. `few-shot-prompting.mdx` has rough legacy edges (informal tone, a multi-line `<Tip>` with a bold label) but those pre-date this PR and the changes to that file were minimal.
🟡	Structure	7/10	`enrich-with-tool.mdx` ends on a FAQ with no CTA — it's a how-to page mid-sequence and readers land there from `create-knowledge.mdx` with nowhere obvious to go next. `inactive-table-deletion.mdx` is not referenced in `docs.json` at all — it exists as a linked sub-page but never appears in the sidebar.

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

✨ Overall vibe: The structural decision here is sound — collapsing eleven separate tool-step pages into a single tabbed knowledge-tool-steps.mdx is much cleaner to maintain and easier for readers to scan. The content itself is well-written and specific. The main drag is a cluster of capitalization inconsistencies (agent vs Agent) that run through the core-concepts overview page, and the SharePoint page which uses "Sharepoint" everywhere except one inline sentence — suggesting a find-replace that missed the frontmatter and headings.

🔧 Issues (17)

Product term capitalization — agent vs Agent

get-started/core-concepts/knowledge.mdx:41 — heading ### Connecting Knowledge to an agent → ### Connecting Knowledge to an Agent (Relevance AI product)
get-started/core-concepts/knowledge.mdx:43 — "When you add a knowledge base to an agent" → "an Agent"
get-started/core-concepts/knowledge.mdx:45 — "every time the agent runs" → "the Agent runs"
get-started/core-concepts/knowledge.mdx:47 — "the agent searches the knowledge base" → "the Agent searches"
get-started/core-concepts/knowledge.mdx:54 — "when your agents need access" → "your Agents need"
get-started/core-concepts/knowledge.mdx:67 — "Run [tools] over your knowledge" → "Run [Tools]" (linking to Relevance AI Tools)
build/knowledge/knowledge-tool-steps.mdx:15 — "as a Tool or agent runs" → "Agent runs"
build/knowledge/knowledge-tool-steps.mdx:52 — "for an agent to call" → "an Agent to call"
build/knowledge/knowledge-tool-steps.mdx:385 — "so your agents can semantically search" → "your Agents can"

Heading sentence case

get-started/core-concepts/knowledge.mdx:31 — ## How Knowledge Works → ## How Knowledge works ("Works" is not a proper noun)
get-started/core-concepts/knowledge.mdx:99 — Card title "Create a Knowledge Base" → "Create a Knowledge base" ("Base" is not a product name)
get-started/core-concepts/knowledge.mdx:104 — Card title "Connect Integrations" → "Connect integrations"

"Sharepoint" → "SharePoint" (Microsoft product name)

build/knowledge/integrated-knowledge-sources/sharepoint.mdx:2–4 — frontmatter title, sidebarTitle, and description all say "Sharepoint"; the accordion FAQ at line 31 also says "my Sharepoint files". The body and step instructions (lines 9, 11, 22, 23, 24) repeat the same error. Note: the accordion answer at line 32 correctly says "SharePoint" — the fix was applied inconsistently.

Outdated content — event already occurred

build/knowledge/inactive-table-deletion.mdx:11 — "On May 4, 2026, Relevance AI will perform a one-time deletion" — today is July 1, 2026; the event is past. The entire page uses future tense ("will perform", "scheduled for", "you will receive") and needs to be rewritten in past tense.
build/knowledge/inactive-table-deletion.mdx:28 — "This email comes from support@relevanceai.com" — CLAUDE.md says to always link to /get-started/support rather than citing email addresses directly. Even as a sender-identification line (anti-phishing context), it still violates the rule.

Callout misuse in few-shot-prompting

example-use-cases/few-shot-prompting.mdx:30–37 — <Tip> contains a bold heading (**Don't take system prompts for granted**) and multiple lines of body text. CLAUDE.md: callouts must be a single short paragraph with no bold labels inside. Either trim to one sentence or lift the content into a proper ### Getting better results with system prompts section.

Broken or ambiguous link

example-use-cases/few-shot-prompting.mdx:61 — [best practice to prepare my CSV data](/build/knowledge/) links to a bare directory path (/build/knowledge/) that likely 404s. The nearest valid page is /build/knowledge/create-knowledge.

Heading refers to product with lowercase

example-use-cases/few-shot-prompting.mdx:63 — ### 4. Search in knowledge → ### 4. Search in Knowledge (refers to the Relevance AI Knowledge product)

UI element formatting inconsistency across integration pages

build/knowledge/integrated-knowledge-sources/confluence.mdx:21–26, google-drive.mdx:22–28, notion.mdx:18–24, sharepoint.mdx:19–26 — Setup steps wrap UI element names in single quotes ('Knowledge', 'Add Confluence', 'Create'). The rest of the Knowledge section uses bold (**Knowledge**, **Create Knowledge**). Pick one convention and apply it throughout; bold is the existing standard in this section.

🧩 Component suggestions (1)

_snippets/components/integrations/knowledge-tool-steps.mdx:1 — uses <Columns cols={2}> to wrap Cards. <Columns> is not a standard Mintlify component (the standard is <CardGroup cols={2}>). Not seen elsewhere in this repo — verify it renders as expected in the Mintlify preview, or swap to <CardGroup cols={2}>. Also worth checking whether this snippet is actually imported anywhere; it doesn't appear in any of the files reviewed.

🏗️ Page structure (3)

build/knowledge/enrich-with-tool.mdx — ends on a FAQ with no closing CTA. This is a mid-sequence how-to page (readers land here from the "What's next?" on create-knowledge.mdx) and there's no obvious next step. Add a ## What's next? with links to /build/knowledge/knowledge-tool-steps (use enriched data in Tool steps) and /build/knowledge/create-knowledge (return to the Knowledge setup guide).
build/knowledge/inactive-table-deletion.mdx — does not appear anywhere in docs.json. The page is reachable via the link in delete-knowledge.mdx but has no sidebar entry. CLAUDE.md's quality checklist says "no orphaned pages (everything is linked from navigation)." Given the event is now past, consider whether this page should be in the nav at all, or whether delete-knowledge.mdx already provides enough context via its <Note>.
build/knowledge/inactive-table-deletion.mdx — see also the outdated content issue above: the page is structured entirely as a future-event explainer but the event occurred two months ago. The <Info> banner, all section intros, and the FAQ answers need to be rewritten in past tense ("On May 4, 2026, Relevance AI performed..." etc.).

⚠️ Contradictions (1)

build/knowledge/delete-knowledge.mdx:22–23 says "Knowledge tables on long-inactive, non-Enterprise accounts **were subject to** a one-time cleanup ... It **was** a single past event" (correct past tense). build/knowledge/inactive-table-deletion.mdx:11 says "Relevance AI **will perform** a one-time deletion" (future tense, incorrect — the event has passed). These two files tell readers opposite things about whether the event is pending or done.

✅ Clean files (8)

build/knowledge/create-knowledge.mdx, build/knowledge/delete-knowledge.mdx, build/knowledge/integrated-knowledge-sources/google-drive.mdx, build/knowledge/integrated-knowledge-sources/notion.mdx, build/knowledge/use-snippets-for-quick-access.mdx, get-started/core-concepts/knowledge.mdx (content quality is good — just the capitalization fixes needed), style.css, docs.json

🔋 Credit usage

Item	Count
Files reviewed	15
Context pages read	0 (all context came from changed files themselves)
Total lines processed	~1,600

Files read: _snippets/components/integrations/knowledge-tool-steps.mdx (26 lines), build/knowledge/create-knowledge.mdx (69 lines), build/knowledge/delete-knowledge.mdx (37 lines), build/knowledge/enrich-with-tool.mdx (85 lines), build/knowledge/inactive-table-deletion.mdx (77 lines), build/knowledge/integrated-knowledge-sources/confluence.mdx (37 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 (408 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 (~100 lines scanned via grep)

The link claimed "best practice to prepare my CSV data" but the target (create-knowledge) has no CSV-prep guidance. Reword to reflect what the page actually covers: uploading and structuring CSV data. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

github-actions · 2026-07-01T05:26:29Z

🎯 Vibe check

Reviewed: 15 MDX files + docs.json (via grep) + style.css (17 total; 11 MDX files with issues, 2 clean; 12 listed files are deleted pages with redirects added in docs.json)

Scores

	Dimension	Score	What's holding it back
🟡	Consistency	6/10	"Sharepoint" misspelled throughout `sharepoint.mdx`; single-quote UI element formatting across all 4 integration source pages; sentence-case violations in `core-concepts/knowledge.mdx` headings and card titles; "Knowledge Search" vs "Knowledge search" inconsistency inside `knowledge-tool-steps.mdx`
🟡	Technical clarity	7/10	TODO placeholder comment left in `delete-knowledge.mdx`; duplicate links with inaccurate text in `few-shot-prompting.mdx`; grammar error in `few-shot-prompting.mdx`; tense mismatch between `inactive-table-deletion.mdx` (future) and `delete-knowledge.mdx` (past) for an event that already happened; Notion step calls pages "files"
🟡	Non-technical clarity	7/10	`few-shot-prompting.mdx` opens with "Let's get started!" and "We're diving into…" — informal tone not in keeping with the content standards; `<Tip>` callout on that same page violates the single-paragraph callout rule with a bold label, two paragraphs, and inline code
🟡	Structure	7/10	`inactive-table-deletion.mdx` exists but is not in `docs.json` navigation (orphaned page); `enrich-with-tool.mdx` has no "What's next?" section despite being a step in a clear how-to sequence; `<Columns>` component in the snippet file is not seen elsewhere in the repo

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

✨ Overall vibe: This is a well-executed restructuring — consolidating scattered tool-step pages into one tabbed knowledge-tool-steps.mdx with thorough examples is a genuine improvement, and the redirects in docs.json are thorough. The main pain points are "SharePoint" misspelled throughout the SharePoint integration page, single-quote UI element formatting across all four integration source pages, and a handful of sentence-case violations in the core-concepts overview. The few-shot-prompting.mdx changes appear to be link updates on old content that has accumulated quality debt; the substantive issues there predate this PR but are surfaced here.

🔧 Issues (19)

build/knowledge/integrated-knowledge-sources/sharepoint.mdx (throughout) — "Sharepoint" → "SharePoint" everywhere: frontmatter title and sidebarTitle (lines 2–3), description (line 4), image alt text (line 7), body text (lines 9, 11), and all step text (lines 19, 22, 23, 24). Note: line 7 alt text also has a typo ("Sharepoint Knowledge Pn") → "SharePoint Knowledge".
build/knowledge/integrated-knowledge-sources/confluence.mdx:21–25, google-drive.mdx:22–28, notion.mdx:19–24, sharepoint.mdx:19–25 — UI element names use single quotes throughout all four integration source pages (e.g., Click 'Knowledge', Click 'Add Confluence'). CLAUDE.md requires bold: Click **Knowledge**, Click **Add Confluence**.
get-started/core-concepts/knowledge.mdx:31 — heading "## How Knowledge Works" → sentence case: "## How Knowledge works" ('works' lowercase).
get-started/core-concepts/knowledge.mdx:41 — heading "### Connecting Knowledge to an agent" — 'agent' should be 'Agent' (the Relevance AI Agent product).
get-started/core-concepts/knowledge.mdx:99 — Card title "Create a Knowledge Base" → "Create a Knowledge base" (sentence case: 'base' is not a proper noun).
get-started/core-concepts/knowledge.mdx:106 — Card title "Connect Integrations" → "Connect integrations" (sentence case).
get-started/core-concepts/knowledge.mdx:67 — link text "[tools]" → "[Tools]" (referring to the Relevance AI Tools product feature).
get-started/core-concepts/knowledge.mdx:50 — link text "[Advanced knowledge search (2M context)]" → "[Advanced Knowledge search (2M context)]" ('Knowledge' is the product feature name; capitalized throughout the rest of the page).
build/knowledge/knowledge-tool-steps.mdx:290–291 — Tab title "Knowledge search" (lowercase 's') but body text immediately below says "The Knowledge Search step" (uppercase 'S'). Same pattern at lines 320–321: tab title "Advanced Knowledge search (2m)" vs body "Advanced Knowledge Search (2M context)". Pick one capitalization and apply it consistently.
build/knowledge/delete-knowledge.mdx:11 — TODO comment left in published content: {/* TODO: Supademo recording of the delete flow */}. Remove before publishing or replace with the recording.
build/knowledge/inactive-table-deletion.mdx:11–11 (throughout the page body) — page uses future tense throughout ("will perform a one-time deletion", "You will receive an email", "will be permanently deleted") for an event scheduled for May 4, 2026. Today is July 1, 2026 — the event has already occurred. Update to past tense: "performed", "received", "were permanently deleted", etc.
build/knowledge/inactive-table-deletion.mdx:28 — hardcodes support@relevanceai.com inline. CLAUDE.md: always link to /get-started/support rather than referencing specific email addresses. Line 42 correctly uses the link; line 28 should too. Suggested rewrite: "This email comes from Relevance AI support — not spam or phishing. You can verify by contacting support if you're unsure."
build/knowledge/integrated-knowledge-sources/notion.mdx:22 — Step 4 says "Select the Notion files you wish to have the Agent read". Notion doesn't use the term "files" — it has pages and databases. Align with the FAQ on that same page which says "pages and databases": "Select the Notion pages or databases you wish to have the Agent read."
example-use-cases/few-shot-prompting.mdx:45 — grammar error: "The pattern shows the LLM that what the expected task is." → "The pattern shows the LLM what the expected task is." (remove "that").
example-use-cases/few-shot-prompting.mdx:24 — heading "### 1. Create the build sales response automation Tool" — "build" is redundant (either "Create the sales response automation Tool" or "Build the sales response automation Tool").
example-use-cases/few-shot-prompting.mdx:30–37 — <Tip> callout contains a bold label (**Don't take system prompts for granted**), two paragraphs, and an inline code block. CLAUDE.md: callouts must be a single short paragraph with no bold labels inside. Convert to a proper ### System prompt tips section with the content as prose, or strip the bold label and condense to one sentence.
example-use-cases/few-shot-prompting.mdx:59–61 — Three consecutive links all point to /build/knowledge/create-knowledge: "Upload", "enable knowledge" (line 60), and "best practice to prepare my CSV data" (line 61). Lines 60–61 have inaccurate link text — the create-knowledge page covers neither "enabling knowledge" nor CSV best practices. Remove or rewrite: one link with the text "create a Knowledge base" is enough.
example-use-cases/few-shot-prompting.mdx:111 — "out-dated" → "outdated" (one word). The bold phrase **A bit out-dated but still useful video** is functioning as a section heading — use #### instead.
example-use-cases/few-shot-prompting.mdx:8–9 — "We're diving into the world of few-shot prompting…Let's get started!" — informal tone not consistent with the technical documentation standard. Replace with a direct sentence describing what the guide covers.

🧩 Component suggestions (2)

_snippets/components/integrations/knowledge-tool-steps.mdx:1 — uses <Columns cols={2}> wrapping <Card> components. Standard Mintlify uses <CardGroup cols={2}>. Not seen elsewhere in this repo — verify it renders as expected before merging.
build/knowledge/integrated-knowledge-sources/confluence.mdx:19–25, google-drive.mdx:21–28, notion.mdx:17–24, sharepoint.mdx:17–25 — all four integration pages have 6-step sequential procedures written as plain numbered lists. These are exactly the kind of sequential procedures that <Steps> is designed for — the visual progress indicator helps users track where they are in the setup flow. Each page would benefit from wrapping the numbered steps in a <Steps> component.

🏗️ Page structure (2)

build/knowledge/inactive-table-deletion.mdx — the page exists and is referenced from delete-knowledge.mdx via a <Note>, but it is not listed anywhere in docs.json navigation. CLAUDE.md: no orphaned pages — everything must be linked from navigation. Add it to the sidebar under build/knowledge/delete-knowledge, or as a sibling entry in the Knowledge section.
build/knowledge/enrich-with-tool.mdx — no "What's next?" section. This is a how-to page that sits squarely in the Create → Enrich → Use sequence. Natural next steps: Knowledge Tool steps (for reading/writing data programmatically once enriched) and Connect Knowledge to an Agent.

⚠️ Contradictions (1)

build/knowledge/inactive-table-deletion.mdx describes the May 4, 2026 event in future tense throughout ("Relevance AI will perform a one-time deletion of Knowledge tables…"). build/knowledge/delete-knowledge.mdx:22 describes the same event in past tense: "Knowledge tables on long-inactive, non-Enterprise accounts were subject to a one-time cleanup". Today is July 1, 2026 — the event is over. inactive-table-deletion.mdx needs to be updated to past tense to match delete-knowledge.mdx and to be factually accurate.

✅ Clean files (2)

build/knowledge/create-knowledge.mdx, build/knowledge/use-snippets-for-quick-access.mdx

Non-MDX notes: style.css adds visual styling for the changelog timeline and the new .path-picker tab component used in knowledge-tool-steps.mdx — no content impact, looks scoped correctly. docs.json restructuring is well done: the navigation hierarchy is logical, all 12 deleted pages have redirects, and the redirect targets (hash anchors on knowledge-tool-steps.mdx) match the actual id attributes on the tabs.

🔋 Credit usage

Item	Count
Files reviewed	17 (15 MDX + docs.json via grep + style.css)
Context pages read	0 (docs.json served as navigation context)
Total lines processed	~1,620

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 (partial, ~100 lines via grep)

github-actions · 2026-07-01T05:32:12Z

🎯 Vibe check

Reviewed: 13 MDX files (8 with issues, 5 clean); 12 files deleted (redirects in place); 2 non-doc files (docs.json, style.css)

Scores

	Dimension	Score	What's holding it back
🟡	Consistency	6/10	"Sharepoint" vs "SharePoint" throughout one page; "Source" capitalized in 4 page titles; `agent`/`agents` lowercase where they should be `Agent`/`Agents`; "knowledge" lowercase in two few-shot-prompting headings; "Advanced knowledge search" vs "Advanced Knowledge search" across files
🟡	Technical clarity	7/10	`Update value` field is described as "an object" but examples show an array — one is wrong; `inactive-table-deletion.mdx` still uses future tense for an event that occurred on May 4, 2026 (today is July 1, 2026)
🟡	Non-technical clarity	7/10	`inactive-table-deletion.mdx` telling readers an event "will" happen in the future when it already has is actively misleading; malformed `<Tip>` in few-shot-prompting that CLAUDE.md rules out
🟡	Structure	7/10	`inactive-table-deletion.mdx` is not in `docs.json` navigation — reachable only via a link from `delete-knowledge.mdx`; the PR consolidation itself is a structural improvement

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

✨ Overall vibe: This is a solid consolidation that merges 11 separate Knowledge tool-step pages into a single tabbed reference, with redirects properly wired in docs.json and a custom .path-picker CSS component that matches the existing pattern in the guides section. The main things holding it back are a pervasive "Sharepoint" capitalization error across the SharePoint page, UI click steps that use single quotes instead of bold text across all four integration source pages, and an inactive-table-deletion.mdx page that is both orphaned from the navigation and written in future tense for an event that already happened.

🔧 Issues (14)

build/knowledge/integrated-knowledge-sources/sharepoint.mdx:2–31 — "Sharepoint" should be "SharePoint" (Microsoft's correct product name capitalization) everywhere in this file. Only the FAQ answer at line 32 gets it right. Affects the frontmatter title, sidebarTitle, description, the intro paragraph, the setup heading, the step instructions, and the FAQ accordion title.
build/knowledge/integrated-knowledge-sources/sharepoint.mdx:2 — Frontmatter title "Sharepoint as a Knowledge Source" — "Source" should be lowercase: "SharePoint as a Knowledge source"
build/knowledge/integrated-knowledge-sources/google-drive.mdx:1 — Frontmatter title "Google Drive as a Knowledge Source" → "Google Drive as a Knowledge source"
build/knowledge/integrated-knowledge-sources/notion.mdx:1 — Frontmatter title "Notion as a Knowledge Source" → "Notion as a Knowledge source"
build/knowledge/integrated-knowledge-sources/confluence.mdx:2 — Frontmatter title "Confluence as a Knowledge Source" → "Confluence as a Knowledge source"
build/knowledge/integrated-knowledge-sources/confluence.mdx:21–26, google-drive.mdx:21–28, notion.mdx:18–24, sharepoint.mdx:19–25 — UI element names in the step lists use single quotes ('Knowledge', 'Add Confluence', 'Create', 'Add Google Drive', etc.) instead of bold text. CLAUDE.md style: Click **Knowledge**, not Click 'Knowledge'.
get-started/core-concepts/knowledge.mdx:32 — Heading ## How Knowledge Works — "Works" should be lowercase: "How Knowledge works"
get-started/core-concepts/knowledge.mdx:43 — Heading ### Connecting Knowledge to an agent — "agent" should be "Agent" (Relevance AI product term; inconsistent with the same section capitalizing "Knowledge" and "Tools")
get-started/core-concepts/knowledge.mdx:50 — Link text Advanced knowledge search (2M context) — "knowledge" should be "Knowledge": "Advanced Knowledge search (2M context)"
build/knowledge/knowledge-tool-steps.mdx:15 — "useful for capturing and storing data dynamically as a Tool or agent runs" — "agent" should be "Agent". Inconsistent: "Tool" is capitalized in the same phrase.
build/knowledge/knowledge-tool-steps.mdx:385 — "so your agents can't semantically search or reference it" — "agents" should be "Agents"
build/knowledge/knowledge-tool-steps.mdx:95–117 — The Update value field description says "an object of new values" but all three examples show a JSON array ([{"breed": "bulldog"}]). These need to agree — either the description should say "an array of objects" or the examples should show a plain object. Verify which the API actually accepts.
example-use-cases/few-shot-prompting.mdx:60 — "enable knowledge" → "enable Knowledge"
example-use-cases/few-shot-prompting.mdx:65 — Heading ### 4. Search in knowledge → "knowledge" should be "Knowledge"

🧩 Component suggestions (1)

example-use-cases/few-shot-prompting.mdx:30–37 — <Tip> contains a bold heading (**Don't take system prompts for granted**), two paragraphs, and an inline code block. CLAUDE.md: callouts must be a single short paragraph with no bold labels inside and no multi-line content. Lift the bold label to a proper ### Don't take system prompts for granted heading above the callout, reduce the <Tip> to the one-liner "Customizing the system prompt with examples specific to your data context improves performance," and move the example prompt to a fenced code block below it.

🏗️ Page structure (1)

build/knowledge/inactive-table-deletion.mdx — Not listed in docs.json navigation. It is reachable via a link from delete-knowledge.mdx but will not appear in the sidebar. Add it under the Knowledge group (e.g. after delete-knowledge) or confirm it's intentionally hidden and note that in a comment.

⚠️ Contradictions (2)

build/knowledge/inactive-table-deletion.mdx:11 says "Relevance AI will perform a one-time deletion on May 4, 2026" (future tense) and inactive-table-deletion.mdx:8 says the event is "scheduled for May 4, 2026." The current date is July 1, 2026 — the event has already happened. Meanwhile delete-knowledge.mdx:22 correctly uses past tense: "were subject to a one-time cleanup." The inactive-table-deletion.mdx page needs to be rewritten in past tense throughout, or replaced with a brief past-event notice that redirects readers who land on it.
build/knowledge/knowledge-tool-steps.mdx (Tab title line 320, snippet line 20) uses Advanced Knowledge search (2m) (lowercase m) while get-started/core-concepts/knowledge.mdx:50 uses Advanced knowledge search (2M context) (uppercase M). "M" for million should be uppercase. Standardize on Advanced Knowledge search (2M) / Advanced Knowledge search (2M context) across both files and the snippet.

✅ Clean files (5)

_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

📋 Non-doc file notes

docs.json — Consolidation looks well-handled: the 11 deleted tool-step pages each have a redirect entry pointing to the correct anchor on /build/knowledge/knowledge-tool-steps. The three deleted overview pages (access-knowledge, advanced-knowledge-retrieval, find-and-use-knowledge) redirect to /get-started/core-concepts/knowledge. Navigation group structure for Knowledge is clean. One gap: inactive-table-deletion has no navigation entry (see page structure issue above).
style.css — Adds the .path-picker CSS component used in knowledge-tool-steps.mdx for the tabbed step layout. The class already exists in several guides pages, so this is a consistent pattern, not a one-off.

🔋 Credit usage

Item	Count
MDX files reviewed	13
Deleted MDX files (content not reviewable)	12
Context pages read	1 (`build/tools/knowledge/knowledge.mdx`)
Non-doc files scanned	2 (docs.json grep, style.css)
Total lines processed	~1,400

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 (85 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 (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), build/tools/knowledge/knowledge.mdx (68 lines), style.css (110 lines)

few-shot-prompting is a hidden page (not in docs.json) and outside this PR's Knowledge scope. Restore it to main, undoing the earlier CSV-link edits so this PR stays focused on the Knowledge-section consolidation. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

github-actions · 2026-07-01T05:49:22Z

🎯 Vibe check

Reviewed: 14 files (7 with issues, 7 clean) + 12 deleted files (redirects verified in docs.json)

Scores

	Dimension	Score	What's holding it back
🟡	Consistency	7/10	"Sharepoint" misspelled throughout sharepoint.mdx (brand name, should be "SharePoint"); single quotes used for UI element names across all four integration source pages instead of bold; one heading capitalization failure in core-concepts/knowledge.mdx
🟡	Technical clarity	7/10	inactive-table-deletion.mdx still uses future tense for a May 4, 2026 event (today is July 1, 2026) — actively misleading to any reader who lands on it; TODO placeholder still in confluence.mdx; email address referenced in body text instead of linking to support page
🟢	Non-technical clarity	9/10	Good analogies and plain-English descriptions throughout; "Yes!" in notion.mdx FAQ is informal but minor
🟡	Structure	7/10	`inactive-table-deletion` page is not in `docs.json` navigation (orphaned); `<Columns>` in the snippet file is a non-standard Mintlify component

Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5. Scores are a single overall judgment about the whole PR — not per file. The dropdowns below contain the line-by-line specifics.

✨ Overall vibe: The PR does solid work consolidating fragmented Knowledge docs into a cleaner, more navigable structure — the knowledge-tool-steps.mdx unification in particular is well-executed, with excellent tabbed examples and thorough FAQs. The main issues are a stale-tense page that's now factually wrong for any reader today (the May 4 cleanup has passed), the same single-quote-instead-of-bold UI formatting mistake repeated across all four integration source pages, and a brand name misspelling (SharePoint → Sharepoint) throughout the SharePoint page.

🔧 Issues (8)

build/knowledge/integrated-knowledge-sources/sharepoint.mdx:3,4,5,7,9,11,15,21–25,31 — "Sharepoint" used throughout but the correct Microsoft brand name is "SharePoint" (capital P). The only correct use is on line 32 inside the FAQ body ("...those files in SharePoint, sync automatically"). Fix the title, sidebarTitle, description, alt text, heading, body, and all quoted UI labels to "SharePoint".
build/knowledge/integrated-knowledge-sources/confluence.mdx:21–25, google-drive.mdx:23–28, notion.mdx:18–24, sharepoint.mdx:20–25 — All four integration source pages wrap UI element names in single quotes ('Knowledge', 'Add Confluence', 'Add Google Drive', 'Create', etc.) instead of bold. CLAUDE.md says: "Click Create agent", not "click the button". These should be **Knowledge**, **Add Confluence**, **Create**, etc. create-knowledge.mdx handles this correctly and is the model to follow.
get-started/core-concepts/knowledge.mdx:32 — Heading ## How Knowledge Works uses title case. Sentence case: ## How Knowledge works.
build/knowledge/inactive-table-deletion.mdx — The entire page is written in future tense ("On May 4, 2026, Relevance AI will perform a one-time deletion…", "You will receive an email…", "All data stored in your Knowledge tables will be permanently deleted…"). Today is July 1, 2026 — this event has passed. Every future-tense claim is now stale and will confuse readers. The page needs a full tense pass: "performed", "sent", "was permanently deleted", etc. The Info callout at line 7 also needs updating ("scheduled for May 4, 2026" → "completed on May 4, 2026").
build/knowledge/inactive-table-deletion.mdx:28 — Body text reads: "This email comes from support@relevanceai.com and is a legitimate notification from Relevance AI". CLAUDE.md policy: link to /get-started/support rather than referencing specific email addresses. In this context the email address is identifying a sender (not directing users to contact it), so this is a judgement call — but to stay consistent, consider rewriting to "This email is a legitimate notification from the Relevance AI support team" and linking to /get-started/support.
build/knowledge/integrated-knowledge-sources/notion.mdx:30 — FAQ answer opens with "Yes!" — the exclamation mark is informal for technical documentation. Change to "Yes." or start with the actual answer: "You can select both Notion pages and databases as Knowledge."
build/knowledge/integrated-knowledge-sources/confluence.mdx:17 — {/* TODO: Supademo recording of the Confluence knowledge setup */} comment is still present. The Confluence page is the only integration source without a demo embed — google-drive.mdx and notion.mdx both have Supademo embeds. Either add the recording or remove the TODO before shipping.
build/knowledge/inactive-table-deletion.mdx:44 — Bare --- horizontal rule before the FAQ heading creates an <hr> that's redundant — the ## Frequently asked questions (FAQs) heading already creates visual separation. Remove the ---.

🧩 Component suggestions (1)

_snippets/components/integrations/knowledge-tool-steps.mdx:1 — Uses <Columns cols={2}> to wrap the Cards, but the standard Mintlify component for this is <CardGroup cols={2}>. <Columns> does not appear in standard Mintlify docs and isn't used elsewhere in this repo. If this renders correctly it may be a Mintlify alias, but it's worth verifying — or replace with <CardGroup cols={2}> to match the rest of the codebase (e.g., create-knowledge.mdx:11, get-started/core-concepts/knowledge.mdx:15).

🏗️ Page structure (1)

build/knowledge/inactive-table-deletion — Not in docs.json navigation. The page is reachable via the link in delete-knowledge.mdx:22 but has no sidebar entry, violating the CLAUDE.md rule "No orphaned pages (everything is linked from navigation)." Add it to docs.json — a natural place would be under "Build with Knowledge" or as a sub-item beside build/knowledge/delete-knowledge. Alternatively, if the intent is to keep it as a deep-link-only page (since the event is now past), document that decision.

⚠️ Contradictions (1)

build/knowledge/delete-knowledge.mdx:22 correctly uses past tense: "Knowledge tables on long-inactive, non-Enterprise accounts were subject to a one-time cleanup." But build/knowledge/inactive-table-deletion.mdx throughout uses future tense ("will perform", "will receive", "will be deleted") for the same event. These two files are in direct conflict about whether the May 4, 2026 cleanup has happened. delete-knowledge.mdx is accurate; inactive-table-deletion.mdx needs a full tense update.

✅ 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, docs.json (redirects well-structured for all deleted pages), style.css (path-picker styles match usage in knowledge-tool-steps.mdx)

🔋 Credit usage

Item	Count
Files reviewed	14
Context pages read	2
Total lines processed	~900

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 (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), get-started/core-concepts/knowledge.mdx (114 lines), docs.json (300 lines, partial), style.css (392 lines). Context: enterprise/data-retention.mdx (30 lines), get-started/core-concepts/agents.mdx (30 lines).

few-shot-prompting is hidden (not in docs.json, no inbound links), but the CI link-check validates all pages. /build/knowledge/ is a 404, so repoint it to a live page. Inline comment marks why the hidden page was touched. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

github-actions · 2026-07-01T06:06:35Z

🎯 Vibe check

Reviewed: 14 MDX files (9 with issues, 5 clean) + docs.json + style.css

Note on missing files: 12 of the 27 files listed in the PR don't exist on disk — they've been deleted and replaced with redirect entries in docs.json. The consolidation is clean: the 7 separate Knowledge tool-step pages now redirect to anchors in the new unified knowledge-tool-steps.mdx, and scattered concept pages (find-and-use-knowledge, access-knowledge, advanced-knowledge-retrieval, get-started/key-concepts/knowledge) redirect to /get-started/core-concepts/knowledge. Redirect mappings look correct.

Scores

	Dimension	Score	What's holding it back
🟡	Consistency	6/10	"Sharepoint" (not "SharePoint") used throughout sharepoint.mdx; "Source" uppercased in all four integrated-source page titles; one sentence-case H2 failure in core-concepts/knowledge; "2m" vs "2M" and "Knowledge Search" vs "Knowledge search" inconsistencies within knowledge-tool-steps.mdx itself.
🟡	Technical clarity	7/10	Notion setup steps say "files" but the page's own FAQ says "pages and databases"; two unfilled Supademo video placeholders (confluence, delete-knowledge); `inactive-table-deletion.mdx` still written in future tense while `delete-knowledge.mdx` describes the same event in past tense — contradictory since May 4, 2026 has now passed.
🟢	Non-technical clarity	9/10	Core concepts page is well-written — clear definition, good analogy, layered complexity. Integrated source pages are appropriately concise.
🟡	Structure	7/10	`inactive-table-deletion.mdx` is absent from docs.json nav, violating the "no orphaned pages" rule. Malformed `<Tip>` callout in few-shot-prompting.mdx (that said, this is a flagged retired page).

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

✨ Overall vibe: The Knowledge section consolidation is well-executed — the new unified knowledge-tool-steps.mdx with tab-based navigation and custom .path-picker styling is a real improvement over 8 separate stub pages, and the redirect strategy in docs.json is clean. The main issues are mechanical: "Sharepoint" → "SharePoint" throughout one file, several sentence-case misses on card titles and page titles, and a tense contradiction on the inactive-table-deletion page that now reads as if a past event is still upcoming.

🔧 Issues (14)

build/knowledge/integrated-knowledge-sources/sharepoint.mdx:2–34 — "Sharepoint" appears in the frontmatter title (line 2), sidebarTitle (line 3), image alt text (line 7), body text (lines 8, 10, 12), step instruction (lines 22–23), and FAQ accordion title (line 31). Every instance must be "SharePoint" (capital P — Microsoft's own spelling). Also, line 2 title has "Source" unnecessarily capitalized → "SharePoint as a Knowledge source".
build/knowledge/integrated-knowledge-sources/confluence.mdx:2 — frontmatter title: "Confluence as a Knowledge Source" → sentence case: "Confluence as a Knowledge source" ("Source" is not a proper noun).
build/knowledge/integrated-knowledge-sources/google-drive.mdx:2 — title: "Google Drive as a Knowledge Source" → "Google Drive as a Knowledge source".
build/knowledge/integrated-knowledge-sources/notion.mdx:2 — title: "Notion as a Knowledge Source" → "Notion as a Knowledge source".
get-started/core-concepts/knowledge.mdx:32 — ## How Knowledge Works → sentence case: ## How Knowledge works ("Works" is not a proper noun).
get-started/core-concepts/knowledge.mdx:99 — Card title="Create a Knowledge Base" → "Base" unnecessarily capitalized: "Create a Knowledge base".
get-started/core-concepts/knowledge.mdx:104 — Card title="Connect Integrations" → "Integrations" unnecessarily capitalized: "Connect integrations".
get-started/core-concepts/knowledge.mdx:50 — link text "Advanced knowledge search (2M context)" uses uppercase "M", while knowledge-tool-steps.mdx consistently uses lowercase "m" in the tab title and FAQs. Pick one — lowercase "2m" matches the majority usage.
build/knowledge/knowledge-tool-steps.mdx:291 — body says "The Knowledge Search step" (capital S) but the Tab title on line 290 is "Knowledge search" (lowercase s). The FAQ on line 402 correctly uses lowercase. Standardize body references to "Knowledge search step".
build/knowledge/knowledge-tool-steps.mdx:321 — body says "Advanced Knowledge Search (2M context)" but the Tab title on line 320 says "Advanced Knowledge search (2m)" — two inconsistencies: "Search" capitalization and "2M" vs "2m". Standardize to match the Tab title: "Advanced Knowledge search (2m context)".
build/knowledge/integrated-knowledge-sources/notion.mdx:24 — step 4 says "Select the Notion files you wish to have the Agent read." Notion has pages and databases, not files. The FAQ on line 30 correctly says "You can select both Notion pages and databases as Knowledge." Update step 4 to "Select the Notion pages or databases you wish to have the Agent read."
build/knowledge/inactive-table-deletion.mdx:28 — references support@relevanceai.com inline. CLAUDE.md policy: link to /get-started/support instead of referencing email addresses directly. A contextual exception may apply here (it's telling users how to spot a legitimate email vs phishing), but consider rewriting as: "This email comes from Relevance AI — not spam or phishing. If you're unsure, contact support to verify."
build/knowledge/delete-knowledge.mdx:11 — TODO comment {/* TODO: Supademo recording of the delete flow */} — video placeholder not yet filled. Low severity (not user-visible).
build/knowledge/integrated-knowledge-sources/confluence.mdx:17 — same: {/* TODO: Supademo recording of the Confluence knowledge setup */} — placeholder not filled. Low severity.

🧩 Component suggestions (3)

example-use-cases/few-shot-prompting.mdx:31–37 — <Tip> contains a bold heading (**Don't take system prompts for granted**), two paragraphs, and a code block. CLAUDE.md explicitly prohibits bold labels, multi-line content, and code blocks inside callouts. Restructure as a subsection: #### Customize your system prompt as a heading, followed by the body text as a paragraph. (This is a retired/hidden page per the PR comment, so severity is low — but it's in a changed file.)
_snippets/components/integrations/knowledge-tool-steps.mdx:1 — uses <Columns cols={2}> to wrap <Card> elements. Mintlify's standard container for this pattern is <CardGroup cols={2}>. <Columns> is not used elsewhere in this repo — verify it renders as expected in production. If not, swap to <CardGroup cols={2}>.
build/knowledge/integrated-knowledge-sources/confluence.mdx:20–26, google-drive.mdx:21–28, notion.mdx:17–25, sharepoint.mdx:19–26 — all four pages reference UI elements with single quotes (e.g., Click 'Knowledge', Click 'Add Confluence') while the rest of the Knowledge section uses bold (e.g., Click **Knowledge** in the left sidebar in create-knowledge.mdx). Single quotes don't render as emphasis in Mintlify MDX. Standardize to bold and add location context: Click **Knowledge** in the left sidebar, Click **Add Confluence**.

🏗️ Page structure (1)

build/knowledge/inactive-table-deletion.mdx — this page does not appear in docs.json navigation. A full grep "knowledge" docs.json finds every other Knowledge section page but not this one. It's reachable only via the <Note> in delete-knowledge.mdx. CLAUDE.md says "No orphaned pages (everything is linked from navigation)." Add it under build/knowledge/delete-knowledge as a child page in docs.json, or as a sibling in the nav group.

⚠️ Contradictions (1)

build/knowledge/inactive-table-deletion.mdx:11 says "On May 4, 2026, Relevance AI will perform a one-time deletion" (future tense). build/knowledge/delete-knowledge.mdx:22–23 says Knowledge tables "were subject to a one-time cleanup" and "It was a single past event" (past tense). Today is July 1, 2026 — the May 4 event has already occurred. inactive-table-deletion.mdx still reads as if the event is upcoming, including the <Info> callout ("scheduled for May 4, 2026") and the final FAQ answer ("after May 4, 2026"). Update the page to past tense throughout and revise the intro to confirm the event has already taken place.

✅ Clean files (7)

build/knowledge/create-knowledge.mdx, build/knowledge/enrich-with-tool.mdx, build/knowledge/use-snippets-for-quick-access.mdx, build/knowledge/knowledge-tool-steps.mdx (aside from listed body/title inconsistencies), docs.json (redirect strategy is correct), style.css

🔋 Credit usage

Item	Count
Files reviewed	16 (14 MDX + docs.json + style.css)
Context pages read	0 additional (all context was within the PR's own changed files)
Total lines processed	~1,600

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

Mintlify link-rot ignores docs.json redirects and checks the target page exists. This PR deletes /build/tools/tool-steps/knowledge/knowledge-search, so the link on the hidden few-shot page was the one remaining break. Point it at the live consolidated /build/knowledge/knowledge-tool-steps. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

github-actions · 2026-07-01T06:14:44Z

🎯 Vibe check

Reviewed: 14 readable files (9 with issues, 5 clean) + 12 deleted files (confirmed via git, all have redirects in docs.json)

Scores

	Dimension	Score	What's holding it back
🟡	Consistency	6/10	"agent/tool" lowercase throughout `get-started/core-concepts/knowledge.mdx` (15+ occurrences), four page titles with "Source" instead of "source", "Sharepoint" misspelled as-written throughout `sharepoint.mdx`, four integration pages using single-quote UI labels instead of bold
🟡	Technical clarity	8/10	Single-quote labels in step instructions across all four integrated-source pages make it harder to scan; `inactive-table-deletion.mdx` uses future tense for a May 4, 2026 event that has already passed (today is July 1, 2026)
🟢	Non-technical clarity	9/10	Content is readable and well-organized; the few-shot page is hidden/legacy
🟢	Structure	9/10	The consolidation of seven individual tool step pages into one tabbed page is clean, redirects are correctly wired; the inactive-table page's outdated future tense is a freshness issue

Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5. Scores cover the whole PR.

✨ Overall vibe: The structural work here is solid — merging seven individual Knowledge tool step pages into a single tabbed page with a custom styled path-picker is a meaningful UX improvement, and the redirects are correctly wired throughout docs.json. The main weakness is a recurring product term capitalization problem: get-started/core-concepts/knowledge.mdx consistently lowercases "agents" and "tools" when referring to Relevance AI product features, and "SharePoint" is misspelled as "Sharepoint" across the entire SharePoint integration page.

Non-doc file notes: docs.json adds redirects for all deleted pages and cleans up navigation — looks correct. style.css adds the .path-picker class used in knowledge-tool-steps.mdx for the custom tab styling — CSS only, no content impact.

🔧 Issues (17)

Heading and title sentence case

get-started/core-concepts/knowledge.mdx:30 — ## How Knowledge Works → capitalize only "Knowledge": ## How Knowledge works
get-started/core-concepts/knowledge.mdx:41 — ### Connecting Knowledge to an agent → "agent" is the product feature here: ### Connecting Knowledge to an Agent
get-started/core-concepts/knowledge.mdx:100 — Card title="Create a Knowledge Base" → "Base" should be lowercase: "Create a Knowledge base"
get-started/core-concepts/knowledge.mdx:105 — Card title="Connect Integrations" → "Integrations" should be lowercase: "Connect integrations"
build/knowledge/integrated-knowledge-sources/confluence.mdx:2 — title: "Confluence as a Knowledge Source" → sentence case: "Confluence as a Knowledge source"
build/knowledge/integrated-knowledge-sources/google-drive.mdx:2 — title: "Google Drive as a Knowledge Source" → "Google Drive as a Knowledge source"
build/knowledge/integrated-knowledge-sources/notion.mdx:2 — title: "Notion as a Knowledge Source" → "Notion as a Knowledge source"
build/knowledge/integrated-knowledge-sources/sharepoint.mdx:2 — title: "Sharepoint as a Knowledge Source" → "SharePoint as a Knowledge source" (fixes both the misspelling and the sentence case)

Product term capitalization — Agents / Tools

get-started/core-concepts/knowledge.mdx:9 — "your agents and tools access" → "your Agents and Tools access"
get-started/core-concepts/knowledge.mdx:33,36,37,39,43,45,46 — "agent" (lowercase) throughout the "How Knowledge Works" section → "Agent" each time (e.g. "When an agent receives a task" → "When an Agent receives a task")
get-started/core-concepts/knowledge.mdx:54,56,57,60,65,66,67,68,82,90 — "agents" and "tools" lowercase in the use-cases and best-practices sections → "Agents" / "Tools". Most egregious: line 67 "Run [tools]... over your knowledge" → "Run [Tools]... over your Knowledge"; line 90 "Enrichment lets you run tools over your knowledge table" → "Tools" / "Knowledge"
build/knowledge/knowledge-tool-steps.mdx:15 — "as a Tool or agent runs" → "as a Tool or Agent runs"
build/knowledge/knowledge-tool-steps.mdx:385 — "so your agents can't semantically search" → "so your Agents can't semantically search"

SharePoint misspelling

build/knowledge/integrated-knowledge-sources/sharepoint.mdx:4,7,9,11,20,23,24,31,32 — "Sharepoint" → "SharePoint" throughout (Microsoft's official spelling). Line 32 in the FAQ answer correctly spells it "SharePoint" — the rest of the file doesn't.

Email address instead of support link

build/knowledge/inactive-table-deletion.mdx:29 — support@relevanceai.com is directly referenced in prose ("This email comes from support@relevanceai.com"). The context here is identifying a legitimate warning email (not directing users to contact support), so this may be intentional, but CLAUDE.md requires linking to /get-started/support rather than hardcoding email addresses. If the address ever changes, the page will silently be wrong.

UI label formatting in step instructions

build/knowledge/integrated-knowledge-sources/confluence.mdx:21-26 — Steps use single quotes for UI labels: Click 'Knowledge', Click 'Add Confluence', etc. Per CLAUDE.md: "CORRECT: Click **Create agent**". Fix: Click **Knowledge**, Click **Add Confluence**, and so on.
build/knowledge/integrated-knowledge-sources/google-drive.mdx:22-28 — Same pattern: Click 'Knowledge', Click 'Add Google Drive', etc. → bold
build/knowledge/integrated-knowledge-sources/notion.mdx:18-24 — Same: Click 'Knowledge', Click 'Add Notion', etc. → bold
build/knowledge/integrated-knowledge-sources/sharepoint.mdx:20-26 — Same: Click 'Knowledge', Click 'Add Sharepoint', etc. → bold + fix spelling

🧩 Component suggestions (2)

_snippets/components/integrations/knowledge-tool-steps.mdx:1 — Uses <Columns cols={2}> wrapping <Card> elements. <Columns> is not a standard Mintlify component; I haven't seen it elsewhere in this repo. The standard pattern for card grids here is <CardGroup cols={2}>. Verify this renders correctly, or swap to <CardGroup>.
build/knowledge/integrated-knowledge-sources/confluence.mdx:19-26 (and same in google-drive, notion, sharepoint) — The six-step setup flow is a sequential procedure; <Steps> would add the visual progress indicator that plain numbered lists don't. Once UI labels are bolded (see Issues above), the combination would be: <Steps> with <Step title="Open your Agent"> etc. The current numbered list format works but loses the scannability benefit Mintlify's Steps component provides for onboarding-style flows.

🏗️ Page structure (1)

build/knowledge/inactive-table-deletion.mdx — The deletion event was scheduled for May 4, 2026; today is July 1, 2026. The page still reads entirely in future tense: "On May 4, 2026, Relevance AI will perform a one-time deletion", "your Knowledge tables will not be deleted", "log in and run an Agent or Tool before the 4-day window closes to prevent deletion." A reader visiting this page now receives actionable-sounding advice for something that already happened. The page should be updated to past tense and the actionable prevention advice removed or updated to reflect that the event is complete.

⚠️ Contradictions (1)

build/knowledge/delete-knowledge.mdx:21-23 describes the inactive-table cleanup in past tense: "Knowledge tables on long-inactive, non-Enterprise accounts were subject to a one-time cleanup… It was a single past event." Meanwhile build/knowledge/inactive-table-deletion.mdx:11 reads "Relevance AI will perform a one-time deletion". Both pages describe the same event — the tenses need to agree, and the inactive-table-deletion page needs to be updated to match.

✅ Clean files (5)

build/knowledge/create-knowledge.mdx, build/knowledge/delete-knowledge.mdx, build/knowledge/enrich-with-tool.mdx, build/knowledge/use-snippets-for-quick-access.mdx, example-use-cases/few-shot-prompting.mdx (hidden/retired page; only link-fix changes in this PR, existing callout structure issue is pre-existing)

🔋 Credit usage

Item	Count
Files reviewed	14
Context pages read	1 (`build/tools/knowledge/knowledge.mdx`)
Total lines processed	~1,350

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 (115 lines), get-started/core-concepts/knowledge.mdx (114 lines), docs.json (1,165 lines), style.css (392 lines), build/tools/knowledge/knowledge.mdx (69 lines, context)

# Conflicts: # docs.json

github-actions · 2026-07-17T03:51:48Z

🎯 Vibe check

Reviewed: 15 files (7 with issues, 8 clean) + 12 deleted files (all have redirects in docs.json ✓)

Scores

	Dimension	Score	What's holding it back
🟡	Consistency	6/10	"Sharepoint" misspelled throughout `sharepoint.mdx`; single quotes instead of bold for UI elements in all 4 integrated-source pages; lowercase "agent/agents/tools" when referring to Relevance AI product features in several places; "Advanced Knowledge Search" name cased three different ways within `knowledge-tool-steps.mdx`; one heading case miss in `core-concepts/knowledge.mdx`.
🟡	Technical clarity	7/10	`inactive-table-deletion.mdx` uses future tense ("will perform", "will receive") for an event that happened May 4, 2026 — 10 weeks ago. It's genuinely misleading. Also references `support@relevanceai.com` directly instead of linking to the support page.
🟢	Non-technical clarity	8/10	Good analogy ("reference library") in the concept page. JSON examples in `knowledge-tool-steps.mdx` are dense but context-appropriate for a reference page. Overall accessible.
🟢	Structure	8/10	The new consolidated `knowledge-tool-steps.mdx` with path-picker Tabs is a clear improvement over 11 separate stub pages. All deleted pages have redirects. Setup steps in the 4 integrated-source pages should use `<Steps>` rather than plain numbered lists.

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

✨ Overall vibe: Solid consolidation PR — collapsing 11 individual tool-step pages into one well-structured reference page is a genuine improvement, and the redirects are all in place. The main issues to fix before merge are the stale future tense in inactive-table-deletion.mdx (the event is in the past) and the consistent "Sharepoint" misspelling; everything else is cleanup that improves but doesn't block.

🔧 Issues (11)

build/knowledge/inactive-table-deletion.mdx:11 — Stale tense throughout. The page says "On May 4, 2026, Relevance AI will perform…" but today is July 17, 2026 — the event happened 10 weeks ago. Every future-tense statement ("will perform", "will receive an email warning", "will be permanently deleted", "will not be deleted") needs to be rewritten in past tense. e.g. "On May 4, 2026, Relevance AI performed a one-time deletion…"
build/knowledge/integrated-knowledge-sources/sharepoint.mdx (title, sidebarTitle, description, line 7, 9, 12, 22–25, FAQ title) — "Sharepoint" → "SharePoint" throughout. The capital P is part of Microsoft's brand name. Currently "Sharepoint" appears 10+ times; "SharePoint" appears once (line 32 inside an FAQ answer), making it internally inconsistent.
get-started/core-concepts/knowledge.mdx:31 — Heading ## How Knowledge Works → ## How Knowledge works (sentence case; "Works" is not a proper noun).
build/knowledge/integrated-knowledge-sources/confluence.mdx:21–26 — Setup steps use single quotes for UI labels ('Knowledge', 'Add Confluence', 'Create'). Per CLAUDE.md: reference exact UI element names in bold. Should be **Knowledge**, **Add Confluence**, **Create**, etc.
build/knowledge/integrated-knowledge-sources/google-drive.mdx:23–28 — Same pattern: 'Knowledge', 'Add Google Drive', 'Create' → bold.
build/knowledge/integrated-knowledge-sources/notion.mdx:17–24 — Same: 'Knowledge', 'Add Notion', 'Create' → bold.
build/knowledge/integrated-knowledge-sources/sharepoint.mdx:19–26 — Same: 'Knowledge', 'Add Sharepoint', 'Create' → bold (and also fix the "Sharepoint" spelling here).
build/knowledge/knowledge-tool-steps.mdx:15 — "as a Tool or agent runs" — "agent" should be "Agent" to match the capitalized "Tool" in the same clause.
build/knowledge/knowledge-tool-steps.mdx:53 — "for an agent to call" → "Agent".
build/knowledge/knowledge-tool-steps.mdx:320–321,406 — Inconsistent feature name within the same page. Tab title: "Advanced Knowledge search (2m)" · Tab body heading: "Advanced Knowledge Search (2M context)" · FAQ accordion: "Advanced Knowledge search (2m context)". Pick one casing and stick with it throughout.
build/knowledge/inactive-table-deletion.mdx:28 — References support@relevanceai.com inline. CLAUDE.md says to link to /get-started/support instead of referencing email addresses directly. (Context: the sentence is identifying a legitimate notification email, not directing users to contact it, so low risk — but it's against the guideline.)

🧩 Component suggestions (2)

build/knowledge/integrated-knowledge-sources/confluence.mdx:19–26, google-drive.mdx:21–28, notion.mdx:15–24, sharepoint.mdx:17–26 — All four pages have 6-step sequential setup procedures written as plain numbered lists. Per CLAUDE.md, <Steps> is appropriate for sequential procedures. Replace with <Steps> / <Step title="..."> blocks — the visual progress indicators help readers track where they are in a multi-step setup.
example-use-cases/few-shot-prompting.mdx:31–37 — <Tip> contains a bold label heading (**Don't take system prompts for granted**) followed by multi-line content. Per CLAUDE.md, callouts must be a single short paragraph with no bold labels inside. However, this is a hidden/retired page (the file itself carries a comment saying it's only being touched for CI link-fix). Flag for future cleanup rather than this PR.

🏗️ Page structure (2)

build/knowledge/inactive-table-deletion.mdx:44 — A bare --- horizontal rule precedes the ## Frequently asked questions (FAQs) heading, creating a visual double-break. The H2 heading is enough — remove the ---.
get-started/core-concepts/knowledge.mdx — No closing CTA for a concept overview page. After the FAQ section the page ends. This is a concept page (definition → benefits → how it works → use cases → best practices → FAQ), so it should end with a CTA pointing readers to action. The "Ready to get started?" CardGroup at lines 98–113 covers this well — but it comes after the --- divider and before the final </CardGroup> close, which is already there. Actually this is fine — the CTA cards at line 98 are present. ✓ Disregard, no issue here.
build/knowledge/inactive-table-deletion.mdx — The page is no longer in the docs.json navigation but is still linked from delete-knowledge.mdx:22. That inbound link keeps it reachable, which is fine. Just note: if the event is now in the past and the page is not navigated to, consider whether the page warrants an update to past-tense archival copy or removal from the link in delete-knowledge.mdx entirely once the dust settles.

⚠️ Contradictions (1)

build/knowledge/inactive-table-deletion.mdx says the deletion event "will" happen (future tense throughout); build/knowledge/delete-knowledge.mdx:22 says "Knowledge tables on long-inactive, non-Enterprise accounts were subject to a one-time cleanup. It was a single past event" (past tense). The cleanup happened May 4, 2026. delete-knowledge.mdx is correct; inactive-table-deletion.mdx needs to be rewritten in past tense to match.

✅ Clean files (8)

_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, example-use-cases/few-shot-prompting.mdx (hidden/retired page, minimal link-fix edits only), style.css (layout CSS, no doc content changes), docs.json (redirects and navigation structure look correct — all 12 deleted pages have redirect rules)

🔋 Credit usage

Item	Count
Files reviewed	15
Context pages read	1
Total lines processed	~1,200

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 (85 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), get-started/core-concepts/knowledge.mdx (114 lines), example-use-cases/few-shot-prompting.mdx (115 lines), style.css (392 lines), build/tools/knowledge/knowledge.mdx (69 lines, context/sibling)

jordanc-relevanceai and others added 2 commits June 9, 2026 16:57

jordanc-relevanceai self-assigned this Jun 10, 2026

mintlify Bot deployed to staging June 10, 2026 04:21 View deployment

jordanc-relevanceai commented Jun 10, 2026

View reviewed changes

Comment thread build/knowledge/integrated-knowledge-sources/google-drive.mdx Outdated

jordanc-relevanceai commented Jun 10, 2026

View reviewed changes

Comment thread build/knowledge/integrated-knowledge-sources/google-drive.mdx Outdated

jordanc-relevanceai commented Jun 10, 2026

View reviewed changes

Comment thread build/knowledge/integrated-knowledge-sources/notion.mdx Outdated

jordanc-relevanceai commented Jun 10, 2026

View reviewed changes

Comment thread build/knowledge/create-knowledge.mdx Outdated

jordanc-relevanceai commented Jun 10, 2026

View reviewed changes

Comment thread build/knowledge/use-snippets-for-quick-access.mdx Outdated

mintlify Bot deployed to staging June 10, 2026 05:27 View deployment

jordanc-relevanceai requested review from NiamhRelevance and alexgraceaus June 10, 2026 06:36

jordanc-relevanceai marked this pull request as ready for review June 10, 2026 06:36

mintlify Bot deployed to staging June 11, 2026 03:53 View deployment

alexgraceaus approved these changes Jun 19, 2026

View reviewed changes

Comment thread example-use-cases/few-shot-prompting.mdx

docs: revert edits to retired few-shot-prompting page

a27b81a

This page is not in docs.json (hidden/retired), so leave it untouched and matching main rather than updating its internal link. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

mintlify Bot deployed to staging July 1, 2026 05:11 View deployment

mintlify Bot deployed to staging July 1, 2026 05:16 View deployment

docs: fix broken CSV-data link in few-shot-prompting

bf88fe6

/build/knowledge/ has no landing page (404); point at create-knowledge to match the adjacent links. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

mintlify Bot deployed to staging July 1, 2026 05:20 View deployment

mintlify Bot deployed to staging July 1, 2026 05:35 View deployment

mintlify Bot deployed to staging July 1, 2026 06:02 View deployment

mintlify Bot deployed to staging July 1, 2026 06:03 View deployment

mintlify Bot deployed to staging July 1, 2026 06:08 View deployment

jordanc-relevanceai requested a review from alexgraceaus July 1, 2026 06:23

Merge remote-tracking branch 'origin/main' into knowledge-updates

7226dd4

# Conflicts: # docs.json

mintlify Bot deployed to staging July 17, 2026 03:47 View deployment

Uh oh!

Conversation

jordanc-relevanceai commented Jun 10, 2026

What this does

Knowledge Tool steps

Styling

Links and redirects

Preview

Uh oh!

mintlify Bot commented Jun 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Jun 10, 2026

🎯 Vibe check

Uh oh!

github-actions Bot commented Jun 11, 2026

🎯 Vibe check

Uh oh!

Uh oh!

github-actions Bot commented Jul 1, 2026

🎯 Vibe check

Uh oh!

github-actions Bot commented Jul 1, 2026

🎯 Vibe check

Uh oh!

github-actions Bot commented Jul 1, 2026

🎯 Vibe check

Uh oh!

github-actions Bot commented Jul 1, 2026

🎯 Vibe check

Uh oh!

github-actions Bot commented Jul 1, 2026

🎯 Vibe check

Uh oh!

github-actions Bot commented Jul 1, 2026

🎯 Vibe check

Uh oh!

github-actions Bot commented Jul 1, 2026

🎯 Vibe check

Uh oh!

github-actions Bot commented Jul 17, 2026

🎯 Vibe check

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mintlify Bot commented Jun 10, 2026 •

edited

Loading