0
Fork 0
mirror of https://github.com/mastra-ai/mastra.git synced 2026-11-17 08:44:46 +00:00
Commit graph

22 commits

Author SHA1 Message Date
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 -->
2026-08-20 11:17:58 +01:00
Alex Booker
b8a98132b9
docs: remove v0 version dropdown (#21659)
Removes the v0 version dropdown from current docs navigation on desktop
and mobile, along with its page availability index and obsolete assets.
Direct v0 URLs and the version switcher on v0 pages remain
unchanged.\n\nTested with the docs build and focused navigation coverage
on desktop, tablet, and mobile.

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

The documentation no longer shows the old v0 version selector. Users can
still open direct v0 links and use the version selector on v0 pages.

## Changes

- Removed the v0 version availability index.
- Removed desktop and mobile version controls.
- Removed related sidebar styles and obsolete icon components.
- Updated navigation tests to confirm that “Change version” is absent
from current documentation.
- Verified desktop, tablet, and mobile navigation behavior.
- Tested the documentation build.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-18 19:07:21 +01:00
Lennart
510e23be6c
chore(docs): Update URLs (#21643) 2026-08-17 12:17:06 +02:00
Lennart
be823d2268
chore(docs): Various follow-ups (#21399) 2026-08-13 14:03:13 +02:00
Alex Booker
ea3bea4c50
docs: retire guides section (#21329) 2026-08-12 15:17:06 +02:00
Alex Booker
b9ae1fe371
docs: add integrations section (#20924)
Co-authored-by: LekoArts <lekoarts@gmail.com>
2026-08-11 16:08:00 +02:00
devin-ai-integration[bot]
9140cacd9d
docs(sidebar): drop Beta badges in Harness, replace remaining Beta badges with New (#21150)
## Description

Harness sidebar entries (Durable Agents, Goals, Schedules, Signals,
Signal Providers, Agent Controller, plus their
`AgentController`/`Signals` reference entries) no longer carry a `beta`
badge. Every other `tags: ['beta']` sidebar entry in
docs/guides/reference is now `tags: ['new']`.

Since the badge no longer conveys beta status, pages that had no beta
admonition got one (`:::experimental`, which renders as a "beta"
callout):

-
`reference/signals/{create-notification-inbox-tool,signal-provider,task-signal-provider,webhook-signal-provider}.mdx`
- `reference/tools/create-code-mode.mdx`
- `docs/server/auth/workers.mdx`, `guides/deployment/mastra-workers.mdx`

All other affected pages already had a beta admonition stating the API
may change (Trace Intelligence keeps its "Private beta" warning).

Interpretation note: harness-related reference entries were treated as
part of Harness, so their badges were removed rather than switched to
New.

Heads up: `pnpm validate` enforces a 30-day window on `new` tags, so
these badges will need removing (or refreshing) within a month.

`pnpm validate` passes.

## Related issue(s)

Requested in Slack:
https://kepler-bej6556.slack.com/archives/C0AV0VBFM0V/p1786355508067289?thread_ts=1786355508.067289&cid=C0AV0VBFM0V

## Type of change

- [x] Documentation update

## Checklist

- [x] I have made corresponding changes to the documentation (if
applicable)


Link to Devin session:
https://app.devin.ai/sessions/b8173ef4fa944cfea51b2fcd708e745a

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

## ELI5

This update makes documentation labels more accurate. It marks beta
features with clear notices and labels newer features as `new`.

## Changes

- Removed incorrect `beta` labels from Harness entries.
- Changed remaining `beta` labels in `docs/guides/reference` to `new`.
- Added `:::experimental` callouts to affected documentation pages.
- Kept existing beta warnings unchanged, including Trace Intelligence’s
“Private beta” warning.
- Added untagged sidebar entries for Schedules, Signals, Signal
Providers, and Agent Controller.
- Confirmed that `pnpm validate` passes.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: alex <alex@mastra.ai>
Co-authored-by: Alex Booker <booker@booker.codes>
2026-08-10 16:03:40 +01:00
Alex Booker
68be5f8212
docs: refine Develop / Deploy navigation (#21152)
## Summary

- reorder the Develop / Deploy section to Storage, Server, Studio, Auth,
and Deploy
- rename the Deployment sidebar item to Deploy
- update the contextual sidebar navigation assertion

## Testing

- `pnpm validate:sidebar-docs`
- `pnpm exec oxfmt --check src/content/en/docs/sidebars.js
tests/navigation.spec.ts`
- `git diff --check`

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

## ELI5

The documentation menu now shows Develop and Deploy pages in a clearer
order. It also uses the shorter name “Deploy” consistently.

## Changes

- Reordered sidebar items to: Studio, Server, Storage, Auth, and Deploy.
- Renamed the `Deployment` sidebar item to `Deploy`.
- Updated the navigation test to expect `Deploy`.
- Validated sidebar checks, formatting, and `git diff --check`.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-10 11:52:28 +01:00
Damien Schneider
f8eacc878d
fix(docs): smooth contextual sidebar transitions (#20933) 2026-08-07 08:40:25 -07:00
Lennart
044f257db3
chore(docs): Polish sidebar UI (#20904) 2026-08-07 15:45:27 +02:00
Lennart
b77bd6f8b5
feat(docs): add contextual sidebar state model (#20740) 2026-08-06 14:55:43 +02:00
Lennart
9817831e21
chore(docs): Move RAG & Voice to guides (#20680) 2026-08-04 14:46:29 +02:00
Benedikt Rötsch
b0f0de20a1
feat(docs): replace custom AI chat with @mastra/docusaurus-plugin-kapa (#19128)
Co-authored-by: Mastra Code (anthropic/claude-opus-4-8) <noreply@mastra.ai>
Co-authored-by: LekoArts <lekoarts@gmail.com>
2026-07-14 14:37:35 +02:00
Benedikt Rötsch
1aa057b108
docs: Use @mastra/docusaurus-plugin-algolia and update React + Docusaurus (#19117)
Co-authored-by: Mastra Code (anthropic/claude-opus-4-8) <noreply@mastra.ai>
Co-authored-by: LekoArts <lekoarts@gmail.com>
2026-07-09 17:02:42 +02:00
Alex Booker
a7311bb786
docs: Move channels into capabilities (#19108)
Co-authored-by: Lennart <lekoarts@gmail.com>
2026-07-09 09:56:04 +02:00
Lennart
d46910a3f8
chore(docs): Refactor sidebar, move platform, reduce streaming (#18354) 2026-06-23 15:40:25 +02:00
Lennart
3ffd9a7e16
chore(docs): Update Studio/Server (#15193)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2026-04-09 08:20:05 -07:00
Benedikt Rötsch
b708e62ce0
docs: fix SSR/client content mismatches for SEO (#13538)
Co-authored-by: Mastra Code <noreply@mastra.ai>
2026-03-12 14:56:05 +01:00
Alex Booker
7830186907
chore(docs): Improve Start journey (#13788)
Update the "Start user journey" by improving the time to action for
creating a new project. This removes the "Start" page and puts its
contents into the /docs page

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

## Summary by CodeRabbit

* **Documentation**
* Restructured getting started content with a new grid-based layout
featuring framework integration options.
* Updated main docs page with accordion-style sections for different use
cases (agents, copilots, workflows).
  * Consolidated the standalone start guide into the main documentation.
* Added URL redirects for backward compatibility with previous
documentation paths.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Lennart <lekoarts@gmail.com>
2026-03-05 10:07:07 +00:00
Benedikt Rötsch
0764075835
feat(docs): add /learn section with video course (#13137)
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Co-authored-by: Guil Hernandez <g.hernandez07@gmail.com>
Co-authored-by: LekoArts <lekoarts@gmail.com>
Co-authored-by: Mastra Code <noreply@mastra.ai>
Co-authored-by: Alex Booker <booker@booker.codes>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2026-03-04 15:50:37 +01:00
Lennart
0533de8a34
chore(docs): Move mastra-code docs (#13530) 2026-02-26 13:11:02 +01:00
Benedikt Rötsch
673fc5111f
Tests: e2e tests for docs (#13483)
Co-authored-by: Mastra Code <noreply@mastra.ai>
2026-02-26 12:21:00 +01:00