Skip to content

docs(TSP-1445): add Context section file viewers documentation - #821

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

claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1445

Conversation

@claude

@claude claude Bot commented Sep 15, 2026

Copy link
Copy Markdown

Summary

  • New page: build/agents/build-your-agent/context.mdx — documents the Context panel in Agent Builder, covering file type viewers (Markdown, CSV/TSV, code, images, binary/Excel, empty files), the unified file bar, Context vs Knowledge distinction, best practices, and related features
  • Cross-references added to 5 existing pages: create-an-agent.mdx, prompt.mdx, create-knowledge.mdx, file-to-text.mdx, convert-spreadsheet-to-json.mdx
  • Navigation updated: docs.json — context page added to the Build an Agent group, positioned after Memory

Changes

File Change
build/agents/build-your-agent/context.mdx New page
build/agents/create-an-agent.mdx Added Context to "What's next?" list
build/agents/build-your-agent/prompt.mdx Added Tip callout referencing Context for reference files
build/knowledge/create-knowledge.mdx Added Knowledge vs Context section and related link
build/tools/tool-steps/file-to-text.mdx Added Note pointing to Context as a no-tool-step alternative
build/tools/tool-steps/convert-spreadsheet-to-json.mdx Added Note on native CSV viewer in Context
docs.json Added context page to Build an Agent navigation group

Feature flag

The Context page includes a note that this feature is in preview and gated behind the ContextFiles PostHog feature flag.

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

🤖 Generated with Claude Code

New page at build/agents/build-your-agent/context covering the Context
panel in Agent Builder, file type viewers (Markdown, CSV/TSV, code,
images, binary/Excel, empty), unified file bar, Context vs Knowledge
distinction, best practices, and related features.

Updated 6 existing pages with cross-references:
- create-an-agent.mdx: added Context to "What's next?" list
- prompt.mdx: added Tip callout referencing Context for reference files
- create-knowledge.mdx: added Knowledge vs Context section and related link
- file-to-text.mdx: added Note pointing to Context as a no-tool alternative
- convert-spreadsheet-to-json.mdx: added Note on CSV native viewer in Context
- docs.json: added context page to Build an Agent navigation group

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude claude Bot added the docs-drafter Documentation drafted by Claude label Sep 15, 2026
@mintlify

mintlify Bot commented Sep 15, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
relevanceai 🟢 Ready View Preview Sep 15, 2026, 3:07 AM

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

@linear

linear Bot commented Sep 15, 2026

Copy link
Copy Markdown

TSP-1445

@github-actions

Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 7 files (5 with issues, 2 clean)

Scores

Dimension Score What's holding it back
🔴 Consistency 4/10 create-knowledge.mdx has ~20 heading capitalization violations (Title Case throughout); prompt.mdx uses two banned words ("robust", "powerful"), has a typo ("Peformance") and a grammar error; create-an-agent.mdx uses "Inventor" for the product feature that's actually called "Invent"; file-to-text.mdx has two heading case violations
🟡 Technical clarity 6/10 file-to-text.mdx has an incomplete cut-off sentence in the intro and an empty "What file types are supported?" section whose content is accidentally placed under the wrong heading; create-knowledge.mdx uses full absolute URLs for internal links instead of root-relative paths; prompt.mdx Note callout has a bold label (prohibited by CLAUDE.md)
🟡 Non-technical clarity 7/10 Most pages are clear and well-structured; the truncated intro sentence in file-to-text.mdx is jarring for any reader; minor grammar error in prompt.mdx intro ("the model the suits")
🟡 Structure 7/10 create-knowledge.mdx renders a duplicate H1 (frontmatter title + inline # heading); file-to-text.mdx has an empty section followed by the content that should fill it placed under the wrong header

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

✨ Overall vibe: The new context.mdx page and the create-an-agent.mdx update are genuinely solid — clear, well-structured, and useful. The big drag is create-knowledge.mdx, which has been written entirely in Title Case for headings and needs a mechanical sentence-casing pass, and file-to-text.mdx, which has a visibly broken intro sentence that needs to be finished before this ships.

🔧 Issues (31)

prompt.mdx

  • prompt.mdx:49 — Grammar: "the model the suits your Agent's needs" → "the model that suits your Agent's needs"
  • prompt.mdx:55 — Typo in Card title: "Peformance-optimized" → "Performance-optimized"
  • prompt.mdx:96 — robust is a banned word: "may not have the robust function-calling abilities" → "may not have the function-calling capabilities"
  • prompt.mdx:101 — powerful is a banned word: "powerful filtering, sorting, and search capabilities" → "filtering, sorting, and search capabilities"
  • prompt.mdx:177 — Heading in Title Case: "Connect Tools Conveniently" → "Connect Tools conveniently"
  • prompt.mdx:179 — Heading in Title Case: "Add Tools to Your Agent" → "Add Tools to your Agent"

create-an-agent.mdx

  • create-an-agent.mdx:45 — Wrong product name: "Inventor will set up the prompt and suggest Tools" → "Invent will set up the prompt and suggest Tools" (the feature is consistently called "Invent" everywhere else)

create-knowledge.mdx — heading capitalization (sentence case required throughout)

  • create-knowledge.mdx:7 — # Create and Organize Knowledge — this creates a duplicate H1 alongside the frontmatter title
  • create-knowledge.mdx:11 — "Creating Knowledge Sources" → "Creating knowledge sources"
  • create-knowledge.mdx:15 — "Manual Input" → "Manual input"
  • create-knowledge.mdx:29 — "Upload Documents" → "Upload documents"
  • create-knowledge.mdx:45 — "Extract Website Content" → "Extract website content"
  • create-knowledge.mdx:57 — "Connect Third-Party Integrations" → "Connect third-party integrations"
  • create-knowledge.mdx:68 — "Organizing Your Knowledge" → "Organizing your knowledge"
  • create-knowledge.mdx:73 — "Structured Tables" → "Structured tables"
  • create-knowledge.mdx:82 — "Document Chunking" → "Document chunking"
  • create-knowledge.mdx:91 — "Knowledge Collections" → "Knowledge collections"
  • create-knowledge.mdx:99 — "Enhancing Knowledge Quality" → "Enhancing knowledge quality"
  • create-knowledge.mdx:103 — "Metadata Enrichment" → "Metadata enrichment"
  • create-knowledge.mdx:111 — "Knowledge Verification" → "Knowledge verification"
  • create-knowledge.mdx:121 — "Semantic Organization" → "Semantic organization"
  • create-knowledge.mdx:130 — "Connecting Knowledge to Agents" → "Connecting Knowledge to agents"
  • create-knowledge.mdx:148 — "Advanced Knowledge Configuration" → "Advanced knowledge configuration"
  • create-knowledge.mdx:150 — "Retrieval Settings" → "Retrieval settings"
  • create-knowledge.mdx:159 — "Knowledge Prioritization" → "Knowledge prioritization"
  • create-knowledge.mdx:168 — "Query Transformation" → "Query transformation"
  • create-knowledge.mdx:177 — "Best Practices for Knowledge Management" → "Best practices for knowledge management"
  • create-knowledge.mdx:197–200 — Related features links use full absolute URLs (https://relevanceai.com/docs/build/knowledge/...) instead of root-relative paths (/build/knowledge/...). CLAUDE.md requires root-relative paths for internal links.

file-to-text.mdx

  • file-to-text.mdx:7 — Incomplete sentence: "…allows you to convert a supported files into text so that" — the sentence is cut off after "so that". Also "a supported files" is ungrammatical (should be "supported files"). Finish the sentence.
  • file-to-text.mdx:25 — Heading in Title Case: "Advanced Settings" → "Advanced settings"
  • file-to-text.mdx:38 — Heading in Title Case and missing hyphen: "LLM Friendly Format" → "LLM-friendly format"
🧩 Component suggestions (2)
  • context.mdx:11 — <Columns cols={2}> is not seen elsewhere in this repo; verify it renders correctly in Mintlify. If it doesn't, <CardGroup cols={2}> is the confirmed alternative.
  • prompt.mdx:95–97 — <Note> starts with a bold label (**Not all models available in the LLM Tool step can be selected as a model for an Agent.**). CLAUDE.md explicitly prohibits bold labels inside callouts. Rewrite as a plain opening sentence: "Not all models available in the LLM Tool step can be selected as an Agent model." followed by the explanation.
🏗️ Page structure (2)
  • file-to-text.mdx:23–27 — The "What file types are supported?" section (line 23) is empty — the supported formats list is placed under "Advanced Settings" (line 25) instead. Move the formats list directly under the "What file types are supported?" heading. "Advanced Settings" should then cover only the LLM Friendly Format checkbox.
  • create-knowledge.mdx:7 — The frontmatter title already renders as the page H1 in Mintlify. The inline # Create and Organize Knowledge heading creates a visible duplicate H1 at the top of the page. Remove the inline H1 and rely on the frontmatter title.
✅ Clean files (2)

build/tools/tool-steps/convert-spreadsheet-to-json.mdx, docs.json (adds build/agents/build-your-agent/context to the nav in the correct position — no issues)

🔋 Credit usage
Item Count
Files reviewed 7 MDX files + docs.json diff
Context pages read 1 (tools.mdx sibling, partial)
Total lines processed ~775

Files read: context.mdx (99 lines), prompt.mdx (225 lines), create-an-agent.mdx (93 lines), create-knowledge.mdx (200 lines), convert-spreadsheet-to-json.mdx (47 lines), file-to-text.mdx (51 lines), build/agents/build-your-agent/tools.mdx (60 lines, context)

This branch was successfully deployed

1 active deployment
staging — 2eb0774d Deployed Sep 15, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-drafter Documentation drafted by Claude

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant