Skip to content

docs: add proactive compression docs#806

Draft
opieter-aws wants to merge 1 commit intostrands-agents:mainfrom
opieter-aws:proactive-compression-docs
Draft

docs: add proactive compression docs#806
opieter-aws wants to merge 1 commit intostrands-agents:mainfrom
opieter-aws:proactive-compression-docs

Conversation

@opieter-aws
Copy link
Copy Markdown
Contributor

Description

Related Issues

Type of Change

  • New content
  • Content update/revision
  • Structure/organization improvement
  • Typo/formatting fix
  • Bug fix
  • Other (please describe):

Checklist

  • I have read the CONTRIBUTING document
  • My changes follow the project's documentation style
  • I have tested the documentation locally using npm run dev
  • Links in the documentation are valid and working

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 1, 2026

Documentation Preview Ready

Your documentation preview has been successfully deployed!

Preview URL: https://d3ehv1nix5p99z.cloudfront.net/pr-cms-806/docs/user-guide/quickstart/overview/

Updated at: 2026-05-07T21:14:44.278Z

Comment thread src/content/docs/user-guide/concepts/model-providers/index.ts Outdated
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 1, 2026

Assessment: Comment

The documentation is well-written and clearly explains a complex feature (proactive context compression). The code snippets follow existing patterns, the section structure is logical, and cross-references between token counting and proactive compression are solid.

Review Notes
  • Correctness: The token counting snippet in index.ts references an undefined agent variable — see inline comment for details.
  • Design doc alignment: The design doc (0008) uses threshold as the parameter name while these docs use compressionThreshold. If the implementation landed with compressionThreshold, this is fine (design doc is aspirational), but worth confirming.

Nice work documenting both the high-level concept and the internals (token estimation strategy, provider support table).

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 5, 2026

Assessment: Approve

This PR adds clear, well-organized documentation for proactive context compression. The code snippets follow established patterns (function scoping, snippet markers), cross-references between pages are consistent, and the external link to the SDK source code is valid. The prior review comment about the undefined agent variable in the token counting snippet has been resolved. No new issues identified.

@opieter-aws opieter-aws force-pushed the proactive-compression-docs branch from f1761dc to c223bc3 Compare May 5, 2026 18:52
@opieter-aws opieter-aws force-pushed the proactive-compression-docs branch from c223bc3 to f91b048 Compare May 7, 2026 21:04
@opieter-aws opieter-aws force-pushed the proactive-compression-docs branch from f91b048 to 50d94b7 Compare May 7, 2026 21:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant