Skip to content

feat: update session manager docs#581

Open
JackYPCOnline wants to merge 8 commits intostrands-agents:mainfrom
JackYPCOnline:session_manager
Open

feat: update session manager docs#581
JackYPCOnline wants to merge 8 commits intostrands-agents:mainfrom
JackYPCOnline:session_manager

Conversation

@JackYPCOnline
Copy link
Contributor

@JackYPCOnline JackYPCOnline commented Feb 25, 2026

Description

Updates the Session Management documentation page to add full TypeScript SDK coverage alongside the existing Python content.

The TypeScript SDK uses a different, snapshot-based session model compared to Python's message-level persistence. This PR documents that model so TypeScript users have a complete reference.

Key changes:

  • Removed the ts_not_supported banner — session management is now supported in the TypeScript SDK
  • Added TypeScript tabs throughout: basic usage, FileStorage, S3Storage, storage directory/key structures, and how session management works
  • Documented the TypeScript-specific snapshot model: snapshot_latest vs immutable history, saveLatestOn strategy table, snapshotTrigger callback with all SnapshotTriggerParams fields, and loadSnapshotId for restoring from a specific snapshot
  • Added a "Custom Storage Backends (TypeScript)" section documenting the SnapshotStorage interface
  • Noted TypeScript-specific S3 behavior: bucket must pre-exist, s3Client vs region config options
  • Added two TypeScript-specific best practice bullets

Python content is unchanged.

Related Issues

Type of Change

  • Content update/revision

Checklist

  • I have read the CONTRIBUTING document
  • My changes follow the project's documentation style
  • I have tested the documentation locally using mkdocs serve
  • 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.

@strands-agent
Copy link
Contributor

Documentation Deployment Complete

Your documentation preview has been successfully deployed!

Preview URL: https://d3ehv1nix5p99z.cloudfront.net/pr-581/

@strands-agent
Copy link
Contributor

Documentation Deployment Complete

Your documentation preview has been successfully deployed!

Preview URL: https://d3ehv1nix5p99z.cloudfront.net/pr-581/

@github-actions
Copy link
Contributor

Assessment: Comment

This is excellent documentation work that adds comprehensive TypeScript SDK coverage for session management. The snapshot-based model is well-explained with clear examples for snapshotTrigger, saveLatestOn strategies, and custom storage backends.

Review Summary
  • Missing Content: The Python "Data Models" section (documenting Session, SessionAgent, SessionMessage) was removed during the refactoring. This valuable reference material should be preserved in the Python tab.
  • Minor: One small formatting issue with a missing space.

The TypeScript-specific additions (snapshot types, persistence triggers table, SnapshotTriggerParams documentation) are thorough and will be very helpful for TypeScript users. Nice work adding the TypeScript-specific best practices at the end!

@github-actions
Copy link
Contributor

github-actions bot commented Mar 9, 2026

Documentation Preview Ready

Your documentation preview has been successfully deployed!

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

Updated at: 2026-03-12T19:48:09.999Z

@github-actions
Copy link
Contributor

Documentation Preview Failed

The documentation deployment encountered an error. Please check the deployment logs for more details.

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.

2 participants