0
Fork 0
mirror of https://github.com/mastra-ai/mastra.git synced 2026-11-17 08:44:46 +00:00
mastra/docs/tests
Alex Booker a23d562207
docs: reframe sandboxes and filesystems guidance (#21786)
## Summary

- clarify static sandbox sharing, resolver ownership, tool policies, and
initialization timing
- document filesystem path namespaces, mount readiness, portable content
search, and local containment boundaries
- explain manual and automatic indexing costs, persistence, and
filesystem synchronization behavior
- correct LSP prerequisites, path safety, and local versus remote
limitations
- clarify Mastra Platform workspace provider lifecycles

## Verification

- focused MDX formatting check
- Remark
- Vale
- production docs build
- git diff --check

## Note

The full docs validation currently reports an unrelated stale `new`
sidebar tag for `mastra-platform/regions`. Frontmatter and sidebar
coverage validation pass.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## ELI5

This PR makes the sandbox documentation clearer. It explains how
sandboxes, files, search, indexing, LSP, and workspaces behave so users
can configure them correctly and avoid unexpected lifecycle or data
issues.

## Changes

- Clarified static sandbox sharing, provider ownership, tool policies,
initialization order, and lifecycle behavior.
- Documented filesystem namespaces, mount readiness, supported backend
combinations, command visibility, and local containment.
- Expanded search documentation for BM25, vector, and hybrid search,
including indexing, persistence, reindexing, and score semantics.
- Documented BM25 normalization, provider-native vector scores,
unclamped combined scores, raw `scoreDetails`, and corpus- and
provider-dependent thresholds.
- Documented LSP installation, prerequisites, path alignment, binary
discovery, security boundaries, and remote limitations.
- Clarified `PlatformFilesystem` and `PlatformSandbox` lifecycles,
including checkpoint preservation and cleanup.
- Updated skills documentation to describe filesystem-backed skills and
direct agent attachment.
- Renamed the sidebar category to `Sandboxes and Filesystems`.

## Verification

- Passed focused MDX formatting, Remark, Vale, production docs build,
and `git diff --check`.
- Frontmatter and sidebar coverage validation passed.
- Full docs validation reports an unrelated stale `new` sidebar tag for
`mastra-platform/regions`.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
History 2026-08-20 11:17:58 +01:00
..
helpers chore(docs): Update URLs (#21643) 2026-08-17 12:17:06 +02:00
navigation.spec.ts docs: reframe sandboxes and filesystems guidance (#21786) 2026-08-20 11:17:58 +01:00
og-image.spec.ts docs: retire guides section (#21329) 2026-08-12 15:17:06 +02:00
smoke.spec.ts docs: Use @mastra/docusaurus-plugin-algolia and update React + Docusaurus (#19117) 2026-07-09 17:02:42 +02:00