Skip to content

docs(TSP-1304): add context management settings documentation#688

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

docs(TSP-1304): add context management settings documentation#688
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1304

Conversation

@claude

@claude claude Bot commented Jun 17, 2026

Copy link
Copy Markdown

Summary

  • Adds new documentation page for the per-agent Context Management settings introduced in PR #15518
  • Covers Compaction mode (Off, Simple, Observational) and Tool output optimization (Pass full, Optimize) as two independent settings
  • Includes configuration steps, performance/cost tradeoffs, best practices with Do/Don't format, and recommendations by agent type
  • Notes that the feature is flag-gated with a legacy "conversation compression" toggle for accounts without the flags enabled
  • Updates docs.json to add the page under Advanced Settings, positioned after Language Model

Test plan

  • Verify page renders correctly in the Mintlify preview
  • Check all internal links resolve (Language Model, Memory, Tools pages)
  • Confirm page appears in the Advanced Settings nav group
  • Review sentence case on all headings
  • Verify no banned words (powerful, seamlessly, effortlessly, etc.)

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

🤖 Generated with Claude Code

Documents the per-agent context management feature introduced in PR #15518,
covering compaction mode (Off/Simple/Observational) and tool output optimization
(Pass full/Optimize), with configuration steps and best practices by agent type.

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

linear Bot commented Jun 17, 2026

Copy link
Copy Markdown

TSP-1304

@mintlify

mintlify Bot commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
relevanceai 🟢 Ready View Preview Jun 17, 2026, 3:52 AM

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

@github-actions

Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 2 files (1 with minor issues, 1 clean)

docs.json adds a single navigation entry (build/agents/build-your-agent/agent-settings/context-management) in the correct Advanced Settings group. Valid JSON, logically placed between language-model and subagents. No rendering concerns.

Scores

Dimension Score What's holding it back
🟢 Consistency 10/10 No issues found.
🟢 Technical clarity 9/10 Feature-flag Note (line 10) doesn't tell users how to get the flags enabled — no action path and no link to support.
🟡 Non-technical clarity 7/10 "feature-flagged" (line 10) is developer jargon. A non-technical reader who sees the legacy toggle has no idea what it means or what to do about it.
🟢 Structure 10/10 No issues found.

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

Overall vibe: This is a clean, well-crafted reference page — clear definitions, useful gotchas, correct component usage, and sentence case throughout. The only real gap is the feature-flag Note: readers who see the legacy toggle are left with no path forward, and "feature-flagged" is jargon that will lose non-technical users entirely.

🔧 Issues (2)
  • build/agents/build-your-agent/agent-settings/context-management.mdx:10 — "feature-flagged" is developer jargon. Readers seeing the legacy toggle won't know what this means or how to get the new experience. Rewrite to something like: "This feature is being rolled out gradually. If you don't see the two dropdowns described on this page, contact support to request access."
  • build/agents/build-your-agent/agent-settings/context-management.mdx:10 — The Note describes what users will see if flags are off but gives no action path. Even technical readers have no signal about whether this is self-serve or requires support intervention.
✅ Clean files (1)

docs.json

🔋 Credit usage
Item Count
Files reviewed 2
Context pages read 2
Total lines processed ~1634

Files read: build/agents/build-your-agent/agent-settings/context-management.mdx (152 lines), docs.json (1125 lines), build/agents/build-your-agent/agent-settings/language-model.mdx (108 lines), build/agents/build-your-agent/agent-settings/general.mdx (249 lines)

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