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

4361 lines
128 KiB

fix(docs): install docs with pnpm on Vercel so catalog: dependencies resolve (#28474) > Opened by @DSchau ## What - `docs/package.json`: adds `packageManager` with the same pnpm pin as the root (`pnpm@11.21.0+sha512…`). Vercel, Corepack and editors read this field to choose the installer, so the docs project now declares pnpm itself instead of depending on Vercel config. - `docs/vercel.json`: sets `installCommand: "pnpm install --frozen-lockfile"`. This is the same command `packages/playground/vercel-preview/vercel.json` already uses, and it makes the deploy explicit. ## Why #28417 changed six docs dependencies to `catalog:`: `react`, `react-dom`, `lucide-react`, `oxfmt`, `tsx` and `vitest`. Only pnpm (with `pnpm-workspace.yaml`) can resolve that protocol. The `mastra-docs-1.x` Vercel deploy passed on `52db47cd` and has failed on every main commit since `ce5d4731` (#28417). `docs/` has neither a lockfile nor a `packageManager` field, so a Vercel project rooted at `docs` has to guess the installer. This PR keeps the catalog change and pins docs to pnpm. ## Proof - A local `pnpm build` in `docs/` passes on main (exit 0, 975 llms.txt files generated). - `pnpm install --frozen-lockfile` with the new field: "Already up to date" on pnpm 11.21.0, no warnings about the docs package. - `docs/package.json` has 0 `catalog:` entries at `52db47cd` and 6 at main. ## Unverified - I couldn't read the Vercel build logs, so the exact install error isn't confirmed. This PR's `mastra-docs-1.x` preview is the real test. - For Vercel to honor the exact pnpm version in `packageManager`, the project needs `ENABLE_EXPERIMENTAL_COREPACK=1`. Without it, Vercel uses its bundled pnpm. - If the Vercel Root Directory is `docs`, "Include files outside the root directory" must stay enabled so pnpm can see the workspace root. ## Risk: low Config only, scoped to the docs package. Two keys to revert. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> <!-- coderabbit-ai-generated:v1 --> ## ELI5 The docs site uses package versions that only pnpm understands. This change tells Vercel to use pnpm when it installs the docs dependencies, and pins the pnpm version. ## Changes - Added the pnpm 11.21.0 package-manager pin to `docs/package.json`. - Set `installCommand` to `pnpm install --frozen-lockfile` in `docs/vercel.json` and in the generator that creates it. This keeps the generated configuration aligned with its source. The supplied information reports a local build and install, but does not verify the Vercel preview. Vercel build logs and review finding counts were not provided. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: mastra-platform[bot] <284800079+mastra-platform[bot]@users.noreply.github.com>
2026-10-26 12:13:39 -07:00
revert(docs): remove end-user connections docs leaked into main (#28184) ## Summary The `@mastra/connect` end-user connections documentation was supposed to ship only on the docs PR [#27334](https://github.com/mastra-ai/mastra/pull/27334), but PRs #26923 and #26928 brought the following end-user connections docs content into main as part of the code merges: - `docs/src/content/en/docs/mastra-platform/connect/end-user-connections.mdx` (new file, from #26923) - `docs/src/content/en/reference/connect/user-connect-routes.mdx` (new file, from #26923) - Sidebar entries for both pages - `resourceId` option added to `credential.mdx` (from #26923) - `resourceId` and `connectPrompt` options added to `tools.mdx` (from #26923 and #26928) This PR removes all of that so #27334 owns the complete end-user connections documentation set. The code APIs remain shipped on main unchanged — only the docs are reverted. The docs PR already carries complete versions of every file touched here and will re-introduce them atomically when it merges. ## Verification - `docs/connect-project-provider-policy` branch (PR #27334) still contains `end-user-connections.mdx`, `user-connect-routes.mdx`, the sidebar entries, and the fuller `resourceId` / `connectPrompt` documentation on `tools.mdx` and `credential.mdx`. - No references to `end-user-connections`, `user-connect-routes`, or `userConnectRoutes` remain in `docs/src/content/en` after this revert. - Diff is 2 insertions / 271 deletions across 6 files. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> <!-- coderabbit-ai-generated:v1 --> ## ELI5 This PR removes documentation about end-user connections and redirects the old page URLs to related Connect pages. It also removes related option details from the reference docs; the PR description says the code APIs do not change. ## Summary - Deleted the end-user connections guide and the `userConnectRoutes()` reference page. - Removed both pages from their sidebars. - Removed `resourceId` from the documented `credential()` options. - Removed `resourceId` and `connectPrompt` from the documented `tools()` options. - Added redirects from the deleted pages and their `/llms.txt` routes to related Connect pages. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: mastracode <284800079+mastra-platform[bot]@users.noreply.github.com>
2026-10-22 14:42:27 -04:00
revert(docs): remove end-user connections docs leaked into main (#28184) ## Summary The `@mastra/connect` end-user connections documentation was supposed to ship only on the docs PR [#27334](https://github.com/mastra-ai/mastra/pull/27334), but PRs #26923 and #26928 brought the following end-user connections docs content into main as part of the code merges: - `docs/src/content/en/docs/mastra-platform/connect/end-user-connections.mdx` (new file, from #26923) - `docs/src/content/en/reference/connect/user-connect-routes.mdx` (new file, from #26923) - Sidebar entries for both pages - `resourceId` option added to `credential.mdx` (from #26923) - `resourceId` and `connectPrompt` options added to `tools.mdx` (from #26923 and #26928) This PR removes all of that so #27334 owns the complete end-user connections documentation set. The code APIs remain shipped on main unchanged — only the docs are reverted. The docs PR already carries complete versions of every file touched here and will re-introduce them atomically when it merges. ## Verification - `docs/connect-project-provider-policy` branch (PR #27334) still contains `end-user-connections.mdx`, `user-connect-routes.mdx`, the sidebar entries, and the fuller `resourceId` / `connectPrompt` documentation on `tools.mdx` and `credential.mdx`. - No references to `end-user-connections`, `user-connect-routes`, or `userConnectRoutes` remain in `docs/src/content/en` after this revert. - Diff is 2 insertions / 271 deletions across 6 files. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> <!-- coderabbit-ai-generated:v1 --> ## ELI5 This PR removes documentation about end-user connections and redirects the old page URLs to related Connect pages. It also removes related option details from the reference docs; the PR description says the code APIs do not change. ## Summary - Deleted the end-user connections guide and the `userConnectRoutes()` reference page. - Removed both pages from their sidebars. - Removed `resourceId` from the documented `credential()` options. - Removed `resourceId` and `connectPrompt` from the documented `tools()` options. - Added redirects from the deleted pages and their `/llms.txt` routes to related Connect pages. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: mastracode <284800079+mastra-platform[bot]@users.noreply.github.com>
2026-10-22 14:42:27 -04:00
2026-08-17 12:17:06 +02:00
docs: consolidate Editor documentation (#20653) ## Summary - consolidate the Editor docs into one task-focused overview page - move prompt block, tool configuration, and versioning details into focused Reference pages - explain database and code storage with concrete configurations and generated JSON examples - update navigation, inbound links, and redirects for the removed Prompt and Tools pages - correct Editor API, tool provider, versioning, and request-context details against the implementation ## Validation - `pnpm validate` - `pnpm format:mdx:check` - `pnpm lint:remark` - targeted Vale checks for changed Editor pages - `pnpm build` - `git diff --check` <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This PR makes the Editor documentation easier to use. It puts common guidance on one overview page and moves detailed prompt, tool, and versioning information into focused reference pages. ## Changes - Replaced the Editor overview with a task-focused guide covering: - Studio workflows - Prompt blocks - Tools and MCP clients - Permissions - Database and repository storage - Version selection - Programmatic access - Added Editor reference pages for: - Prompt blocks - Tool configuration - Versioning - Expanded tool provider documentation for Composio and Arcade. - Documented Editor storage configuration, including the `editor` option in `MastraCompositeStore`. - Updated API, versioning, request-context, storage, and tool provider details to match the implementation. - Removed the separate Prompt and Tools pages. - Updated sidebars, inbound links, playground links, and redirects for the removed pages. - Added examples for `codePath`, `MastraCompositeStore`, Composio, Arcade, REST draft creation, and agent namespaces. ## Validation - `pnpm validate` - MDX formatting and Remark lint checks - Targeted Vale checks - `pnpm build` - `git diff --check` <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-04 14:38:27 +01:00
2026-08-17 12:17:06 +02:00
docs: consolidate Editor documentation (#20653) ## Summary - consolidate the Editor docs into one task-focused overview page - move prompt block, tool configuration, and versioning details into focused Reference pages - explain database and code storage with concrete configurations and generated JSON examples - update navigation, inbound links, and redirects for the removed Prompt and Tools pages - correct Editor API, tool provider, versioning, and request-context details against the implementation ## Validation - `pnpm validate` - `pnpm format:mdx:check` - `pnpm lint:remark` - targeted Vale checks for changed Editor pages - `pnpm build` - `git diff --check` <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This PR makes the Editor documentation easier to use. It puts common guidance on one overview page and moves detailed prompt, tool, and versioning information into focused reference pages. ## Changes - Replaced the Editor overview with a task-focused guide covering: - Studio workflows - Prompt blocks - Tools and MCP clients - Permissions - Database and repository storage - Version selection - Programmatic access - Added Editor reference pages for: - Prompt blocks - Tool configuration - Versioning - Expanded tool provider documentation for Composio and Arcade. - Documented Editor storage configuration, including the `editor` option in `MastraCompositeStore`. - Updated API, versioning, request-context, storage, and tool provider details to match the implementation. - Removed the separate Prompt and Tools pages. - Updated sidebars, inbound links, playground links, and redirects for the removed pages. - Added examples for `codePath`, `MastraCompositeStore`, Composio, Arcade, REST draft creation, and agent namespaces. ## Validation - `pnpm validate` - MDX formatting and Remark lint checks - Targeted Vale checks - `pnpm build` - `git diff --check` <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-04 14:38:27 +01:00
2026-08-17 12:17:06 +02:00
docs: consolidate Editor documentation (#20653) ## Summary - consolidate the Editor docs into one task-focused overview page - move prompt block, tool configuration, and versioning details into focused Reference pages - explain database and code storage with concrete configurations and generated JSON examples - update navigation, inbound links, and redirects for the removed Prompt and Tools pages - correct Editor API, tool provider, versioning, and request-context details against the implementation ## Validation - `pnpm validate` - `pnpm format:mdx:check` - `pnpm lint:remark` - targeted Vale checks for changed Editor pages - `pnpm build` - `git diff --check` <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This PR makes the Editor documentation easier to use. It puts common guidance on one overview page and moves detailed prompt, tool, and versioning information into focused reference pages. ## Changes - Replaced the Editor overview with a task-focused guide covering: - Studio workflows - Prompt blocks - Tools and MCP clients - Permissions - Database and repository storage - Version selection - Programmatic access - Added Editor reference pages for: - Prompt blocks - Tool configuration - Versioning - Expanded tool provider documentation for Composio and Arcade. - Documented Editor storage configuration, including the `editor` option in `MastraCompositeStore`. - Updated API, versioning, request-context, storage, and tool provider details to match the implementation. - Removed the separate Prompt and Tools pages. - Updated sidebars, inbound links, playground links, and redirects for the removed pages. - Added examples for `codePath`, `MastraCompositeStore`, Composio, Arcade, REST draft creation, and agent namespaces. ## Validation - `pnpm validate` - MDX formatting and Remark lint checks - Targeted Vale checks - `pnpm build` - `git diff --check` <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-04 14:38:27 +01:00
2026-08-17 12:17:06 +02:00
draft: Add MastraPlatformExporter and MastraStorageExporter, deprecate CloudExporter and DefaultExporter (#16223) ## Description Renames two built-in observability exporters in `@mastra/observability` to clearer names that better describe what they do. Both renames use a **duplicate-and-deprecate** pattern: the original classes are preserved unchanged (same exporter `name` strings, same error IDs, same runtime behavior) and marked `@deprecated`; the new classes ship in their own files with updated identifiers. | Old | New | | - | - | | `CloudExporter` | `MastraPlatformExporter` | | `DefaultExporter` | `MastraStorageExporter` | This means existing imports keep working without modification, and any monitoring rules or dashboards matching the old `CLOUD_EXPORTER_*` error IDs / `mastra-cloud-observability-exporter` name / `mastra-default-observability-exporter` name keep firing until users migrate. ### What changed - **New classes**: - `MastraPlatformExporter` in `observability/mastra/src/exporters/mastra-platform.ts` (uses `MASTRA_PLATFORM_EXPORTER_*` error IDs and `mastra-platform-exporter` name). - `MastraStorageExporter` in `observability/mastra/src/exporters/mastra-storage.ts` (uses `mastra-storage-exporter` name). - Each has its own test file (`mastra-platform.test.ts`, `mastra-storage.test.ts`). - **Deprecated classes** in `cloud.ts` and `default.ts` — implementation byte-identical to the previous release, but now carry `@deprecated` JSDoc pointing at the new classes. The deprecated reference doc pages stay at their original URLs (`/reference/observability/tracing/exporters/cloud-exporter` and `/.../default-exporter`) so existing bookmarks keep working. - **Public exports**: all four classes (and their config interfaces) are exported from `@mastra/observability`. - **Internal callers** updated to use the new classes: the deprecated `default` observability config in `default.ts`, the `mastracode` runtime bootstrap, the `mastra` CLI `init` template, and `@mastra/core` JSDoc and bootstrap warning messages. - **Templates and examples**: all 11 templates, the `agent-v6` and `agent` examples, the `e2e-tests/no-bundling` and `e2e-tests/client-js` fixtures, and the `examples/inngest` README now use the new classes. - **Docs**: every overview page, exporter page, processor page, migration guide, storage reference page, and tracing reference page now recommends the new classes. Two doc pages were renamed (`cloud.mdx` → `mastra-platform.mdx`, `default.mdx` → `mastra-storage.mdx`) with permanent redirects from the old URLs in `docs/vercel.json`. Sidebars now list both deprecated reference pages alongside the new ones; the deprecated entries get a `(deprecated)` label and a `sidebar-item-deprecated` className hook. - **Codemod**: added `MastraPlatformExporter` and `MastraStorageExporter → @mastra/observability` mappings alongside the existing `CloudExporter` / `DefaultExporter` entries. ### Trade-off Each pair of files (`cloud.ts` / `mastra-platform.ts`, `default.ts` / `mastra-storage.ts`) is ~99% identical today. Bug fixes to the new classes will not auto-apply to the deprecated ones — but since the deprecated classes are now frozen for back-compat, that's the intended outcome until they're removed in a future major. ### Migration ```ts // Before import { Observability, DefaultExporter, CloudExporter, SensitiveDataFilter } from '@mastra/observability' new Observability({ configs: { default: { serviceName: 'my-app', exporters: [new DefaultExporter(), new CloudExporter()], spanOutputProcessors: [new SensitiveDataFilter()], }, }, }) // After import { Observability, MastraStorageExporter, MastraPlatformExporter, SensitiveDataFilter } from '@mastra/observability' new Observability({ configs: { default: { serviceName: 'my-app', exporters: [new MastraStorageExporter(), new MastraPlatformExporter()], spanOutputProcessors: [new SensitiveDataFilter()], }, }, }) ``` Constructor signatures, environment variables (`MASTRA_CLOUD_ACCESS_TOKEN`, `MASTRA_PROJECT_ID`, `MASTRA_CLOUD_TRACES_ENDPOINT`), and runtime behavior are all unchanged. Update monitoring rules that match on `CLOUD_EXPORTER_*` IDs, `mastra-cloud-observability-exporter`, or `mastra-default-observability-exporter` when you migrate — the new classes use `MASTRA_PLATFORM_EXPORTER_*`, `mastra-platform-exporter`, and `mastra-storage-exporter`. ## Type of Change - [x] New feature (non-breaking change that adds functionality) - [x] Documentation update - [x] Code refactoring ## Checklist - [x] Documentation updated (overview, reference, migration guides, dedicated exporter pages) - [x] Tests added for the new classes (`mastra-platform.test.ts`, `mastra-storage.test.ts`); existing `cloud.test.ts` and `default.test.ts` retained unchanged for the deprecated classes - [x] Backward compatibility preserved: `CloudExporter` and `DefaultExporter` keep their original error IDs, exporter `name`, and runtime behavior https://claude.ai/code/session_014DDGpY9LbumVTqdWX5aGmr Co-authored-by: Claude <noreply@anthropic.com>
2026-05-11 15:51:43 +02:00
draft: Add MastraPlatformExporter and MastraStorageExporter, deprecate CloudExporter and DefaultExporter (#16223) ## Description Renames two built-in observability exporters in `@mastra/observability` to clearer names that better describe what they do. Both renames use a **duplicate-and-deprecate** pattern: the original classes are preserved unchanged (same exporter `name` strings, same error IDs, same runtime behavior) and marked `@deprecated`; the new classes ship in their own files with updated identifiers. | Old | New | | - | - | | `CloudExporter` | `MastraPlatformExporter` | | `DefaultExporter` | `MastraStorageExporter` | This means existing imports keep working without modification, and any monitoring rules or dashboards matching the old `CLOUD_EXPORTER_*` error IDs / `mastra-cloud-observability-exporter` name / `mastra-default-observability-exporter` name keep firing until users migrate. ### What changed - **New classes**: - `MastraPlatformExporter` in `observability/mastra/src/exporters/mastra-platform.ts` (uses `MASTRA_PLATFORM_EXPORTER_*` error IDs and `mastra-platform-exporter` name). - `MastraStorageExporter` in `observability/mastra/src/exporters/mastra-storage.ts` (uses `mastra-storage-exporter` name). - Each has its own test file (`mastra-platform.test.ts`, `mastra-storage.test.ts`). - **Deprecated classes** in `cloud.ts` and `default.ts` — implementation byte-identical to the previous release, but now carry `@deprecated` JSDoc pointing at the new classes. The deprecated reference doc pages stay at their original URLs (`/reference/observability/tracing/exporters/cloud-exporter` and `/.../default-exporter`) so existing bookmarks keep working. - **Public exports**: all four classes (and their config interfaces) are exported from `@mastra/observability`. - **Internal callers** updated to use the new classes: the deprecated `default` observability config in `default.ts`, the `mastracode` runtime bootstrap, the `mastra` CLI `init` template, and `@mastra/core` JSDoc and bootstrap warning messages. - **Templates and examples**: all 11 templates, the `agent-v6` and `agent` examples, the `e2e-tests/no-bundling` and `e2e-tests/client-js` fixtures, and the `examples/inngest` README now use the new classes. - **Docs**: every overview page, exporter page, processor page, migration guide, storage reference page, and tracing reference page now recommends the new classes. Two doc pages were renamed (`cloud.mdx` → `mastra-platform.mdx`, `default.mdx` → `mastra-storage.mdx`) with permanent redirects from the old URLs in `docs/vercel.json`. Sidebars now list both deprecated reference pages alongside the new ones; the deprecated entries get a `(deprecated)` label and a `sidebar-item-deprecated` className hook. - **Codemod**: added `MastraPlatformExporter` and `MastraStorageExporter → @mastra/observability` mappings alongside the existing `CloudExporter` / `DefaultExporter` entries. ### Trade-off Each pair of files (`cloud.ts` / `mastra-platform.ts`, `default.ts` / `mastra-storage.ts`) is ~99% identical today. Bug fixes to the new classes will not auto-apply to the deprecated ones — but since the deprecated classes are now frozen for back-compat, that's the intended outcome until they're removed in a future major. ### Migration ```ts // Before import { Observability, DefaultExporter, CloudExporter, SensitiveDataFilter } from '@mastra/observability' new Observability({ configs: { default: { serviceName: 'my-app', exporters: [new DefaultExporter(), new CloudExporter()], spanOutputProcessors: [new SensitiveDataFilter()], }, }, }) // After import { Observability, MastraStorageExporter, MastraPlatformExporter, SensitiveDataFilter } from '@mastra/observability' new Observability({ configs: { default: { serviceName: 'my-app', exporters: [new MastraStorageExporter(), new MastraPlatformExporter()], spanOutputProcessors: [new SensitiveDataFilter()], }, }, }) ``` Constructor signatures, environment variables (`MASTRA_CLOUD_ACCESS_TOKEN`, `MASTRA_PROJECT_ID`, `MASTRA_CLOUD_TRACES_ENDPOINT`), and runtime behavior are all unchanged. Update monitoring rules that match on `CLOUD_EXPORTER_*` IDs, `mastra-cloud-observability-exporter`, or `mastra-default-observability-exporter` when you migrate — the new classes use `MASTRA_PLATFORM_EXPORTER_*`, `mastra-platform-exporter`, and `mastra-storage-exporter`. ## Type of Change - [x] New feature (non-breaking change that adds functionality) - [x] Documentation update - [x] Code refactoring ## Checklist - [x] Documentation updated (overview, reference, migration guides, dedicated exporter pages) - [x] Tests added for the new classes (`mastra-platform.test.ts`, `mastra-storage.test.ts`); existing `cloud.test.ts` and `default.test.ts` retained unchanged for the deprecated classes - [x] Backward compatibility preserved: `CloudExporter` and `DefaultExporter` keep their original error IDs, exporter `name`, and runtime behavior https://claude.ai/code/session_014DDGpY9LbumVTqdWX5aGmr Co-authored-by: Claude <noreply@anthropic.com>
2026-05-11 15:51:43 +02:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-08-12 14:17:06 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-08-12 14:17:06 +01:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
feat!: rename heartbeats to schedules and unify with workflow schedules (#18874) Renames the heartbeats feature to schedules before we promote it, and merges agent + workflow scheduling into one API. "Heartbeat" reads as a liveness/health check to most programmers, but the feature is cron-based agent scheduling — so now there's a single `mastra.schedules` surface (create/get/list/update/pause/resume/run/delete) that handles both agent and workflow targets, discriminated by `agentId` vs `workflowId`. ```ts // before await mastra.heartbeats.create({ agentId: 'chef', cron: '0 9 * * *', prompt: 'Morning check-in' }); // after — same API also covers workflow schedules await mastra.schedules.create({ agentId: 'chef', cron: '0 9 * * *', prompt: 'Morning check-in' }); await mastra.schedules.create({ workflowId: 'digest', cron: '0 8 * * 1' }); ``` Server-side, `/api/heartbeats` is merged into `/api/schedules` (10 routes). Client-js gains `createSchedule`/`updateSchedule`/`deleteSchedule`/`runSchedule`, and the old heartbeat methods are deprecated but still work by delegating to the schedules API. Existing stored rows keep working: a read-shim in all 8 store implementations normalizes legacy `target.type: 'heartbeat'` rows to `'agent'` at deserialization. New agent schedule ids use the `agent_` prefix (old `hb_` ids still resolve when passed in full). Docs moved from `agents/heartbeats` to `agents/schedules` with a redirect. Verified with the core/server/client-js/store test suites (typecheck clean), plus an HTTP smoke test through the hono adapter covering full CRUD, pause/resume, manual run with trigger recording, legacy-row read-shim, and `/api/heartbeats` returning 404. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This PR renames “heartbeats” to “schedules” and uses one unified feature for both agent cron scheduling and workflow scheduling. It also keeps old saved heartbeat data working by automatically treating it as agent schedules, while moving the HTTP/SDK APIs and docs to the new `/api/schedules` + `mastra.schedules` system. ## Summary - Renamed the heartbeats feature to **schedules** and introduced a unified `mastra.schedules` API for both **agent** and **workflow** scheduling. - Added `mastra.schedules` operations: **create, get, list, update, pause, resume, run, delete**, distinguishing targets by **`agentId` vs `workflowId`**. - Consolidated server routes: **removed `/api/heartbeats`** and added **`/api/schedules`**; legacy heartbeat endpoints now return **404**. - Updated `@mastra/client-js` with new methods: **`createSchedule`, `updateSchedule`, `deleteSchedule`, `runSchedule`** and a schedule-shaped response model; kept old heartbeat client methods as **deprecated wrappers** delegating to the schedules API. - Implemented backward compatibility in storage: on read, all store implementations normalize legacy persisted rows with `target.type: 'heartbeat'` into `target.type: 'agent'`, and legacy **`hb_`** IDs still resolve when provided fully. - Introduced new schedule ID semantics: **agent schedules use `agent_` prefix** (workflow schedules use their new `schedule_` prefix). - Updated runtime orchestration to use schedule workers/topics (including scheduler + agent-schedule startup behavior) and added the “worker startup race” fix by memoizing the in-flight scheduler worker startup promise (with a regression test). - Tightened schedule create validation: `agentId`/`workflowId` now require `.min(1)` and create schemas are `.strict()` to prevent ambiguous payload routing (clear 400s). - Improved hookless schedule handling: schedule hook context loading is only attempted when hooks exist; lookup failures are now debug-logged instead of silently swallowed. - Migrated documentation and examples from **heartbeats → schedules**, including new pages, sidebar updates, and Vercel redirects. - Updated/extended tests across core, server, client-js, and storage (including an HTTP smoke test for CRUD, pause/resume, manual run, legacy-row reads, and `/api/heartbeats` → 404). - Bumped peer dependency ranges for affected packages to align with the updated `@mastra/core`. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Mastra Code (anthropic/claude-fable-5) <noreply@mastra.ai>
2026-07-06 14:15:40 +02:00
2026-08-17 12:17:06 +02:00
docs(signals): reorganize Signals docs into task-based guides (#28022) ## Why The Signals documentation was one 555-line page under **Harness** that tried to cover four different jobs at once: explaining what signals are, showing how to send them, documenting state signals and notifications, and explaining providers and multi-process deployment. Readers had to scan a single long page to find the one task they cared about, and reference-level details were mixed in with the guide. This reorganizes Signals as a first-class section under **Extend** and gives each reader task its own page. The conceptual spine is **signals are input; thread streams are output**. `Agent` stays the primary API; the AgentController `Session` surface is shown as a higher-level mapping, not the default. ## What changed - Added seven Signals guides under `/docs/signals`: - **Overview**: when to use signals, the thread/run/signal/thread-stream model, Quickstart, and choosing an API surface - **Thread streams**: subscribe-before-send, stored history, chunks, approvals, filtering, reconnect, and replay boundaries - **Sending signals**: message and typed-signal input, delivery timing, payloads, cancellation, and the Agent-versus-Session mapping - **State signals**: snapshots and deltas, processor-computed state, deduplication, persistence, and built-in uses - **Notifications**: durable inbox records, deduplication/coalescing, delivery policies, dispatch, retries, and the inbox tool - **Signal providers**: subscriptions, polling, webhooks, lifecycle hooks, processors/tools, and production concerns - **Running across processes**: leases, remote routing, delivery guarantees, crashes, serverless, and shutdown - Moved the section from **Harness** to **Extend**, immediately after **Channels**. - Added `reference/signals/notifications` for `NotificationRecord`, priorities, statuses, delivery decisions, policy evaluation, dispatch configuration, and delivered-signal metadata. - Added `reference/signals/thread-events` for the public `subscribeThreadEvents()` surface and `AgentThreadEvent`. The internal thread-runtime event union is deliberately not documented as public API. - Added the `thread-history` chunk to the `ChunkType` reference, including `messages`, `hasMore`, and the `withInitialHistory` condition. - Moved the Mastra Code cross-agent setup to `docs/src/mastra-code/configuration.mdx` and left a pointer from the Signals overview. - Updated the docs and reference sidebars, inbound links, and page-level redirects from the old Harness routes. - Folded the separate “Signals in the agent loop” draft page into the pages that own its material (Sending signals, Thread streams, Running across processes, Processors, and the tracing overview). ## Test plan - [x] `pnpm --filter mastra-docs test -- --reporter=dot` — 170 tests passed - [x] `pnpm --filter mastra-docs validate:frontmatter` — 679 files passed - [x] `pnpm --filter mastra-docs validate:reference-sidebar` — sort order passed - [x] `pnpm --filter mastra-docs validate:sidebar-docs` — all docs linked - [x] `pnpm --filter mastra-docs format:mdx:check` — 717 MDX files checked - [x] `pnpm --filter mastra-docs lint:remark` — passed - [x] `pnpm --filter mastra-docs exec oxfmt-mdx --check src/mastra-code/configuration.mdx` — passed - [x] `pnpm --filter mastra-docs build` — production build succeeded - [x] `git diff --check` — clean Docs-only change. No runtime, package, dependency, or changeset changes. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> <!-- coderabbit-ai-generated:v1 --> ## ELI5 This PR moves the Signals documentation into a set of task-based guides and updates links from the old pages. It also adds references for notifications and thread events, so readers can find details about how signals and thread updates work. ## Changes - Adds seven guides under **Extend** for the Signals model, thread streams, sending signals, state signals, notifications, providers, and multi-process setup. - Adds reference pages for notifications and thread events, and documents the `thread-history` stream chunk. - Updates the sidebars, links, and permanent redirects for the new documentation paths. - Moves Mastra Code cross-agent setup guidance to its configuration page. - Updates processor documentation with a reactive signal example and documents the `computeStateSignal` processor hook. ## Validation The PR author reports that the documentation tests, validators, formatting checks, build, and `git diff --check` passed. The reported test run had 170 tests. These results were not independently verified. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: mastracode <284800079+mastra-platform[bot]@users.noreply.github.com>
2026-10-22 16:23:52 +02:00
docs(signals): reorganize Signals docs into task-based guides (#28022) ## Why The Signals documentation was one 555-line page under **Harness** that tried to cover four different jobs at once: explaining what signals are, showing how to send them, documenting state signals and notifications, and explaining providers and multi-process deployment. Readers had to scan a single long page to find the one task they cared about, and reference-level details were mixed in with the guide. This reorganizes Signals as a first-class section under **Extend** and gives each reader task its own page. The conceptual spine is **signals are input; thread streams are output**. `Agent` stays the primary API; the AgentController `Session` surface is shown as a higher-level mapping, not the default. ## What changed - Added seven Signals guides under `/docs/signals`: - **Overview**: when to use signals, the thread/run/signal/thread-stream model, Quickstart, and choosing an API surface - **Thread streams**: subscribe-before-send, stored history, chunks, approvals, filtering, reconnect, and replay boundaries - **Sending signals**: message and typed-signal input, delivery timing, payloads, cancellation, and the Agent-versus-Session mapping - **State signals**: snapshots and deltas, processor-computed state, deduplication, persistence, and built-in uses - **Notifications**: durable inbox records, deduplication/coalescing, delivery policies, dispatch, retries, and the inbox tool - **Signal providers**: subscriptions, polling, webhooks, lifecycle hooks, processors/tools, and production concerns - **Running across processes**: leases, remote routing, delivery guarantees, crashes, serverless, and shutdown - Moved the section from **Harness** to **Extend**, immediately after **Channels**. - Added `reference/signals/notifications` for `NotificationRecord`, priorities, statuses, delivery decisions, policy evaluation, dispatch configuration, and delivered-signal metadata. - Added `reference/signals/thread-events` for the public `subscribeThreadEvents()` surface and `AgentThreadEvent`. The internal thread-runtime event union is deliberately not documented as public API. - Added the `thread-history` chunk to the `ChunkType` reference, including `messages`, `hasMore`, and the `withInitialHistory` condition. - Moved the Mastra Code cross-agent setup to `docs/src/mastra-code/configuration.mdx` and left a pointer from the Signals overview. - Updated the docs and reference sidebars, inbound links, and page-level redirects from the old Harness routes. - Folded the separate “Signals in the agent loop” draft page into the pages that own its material (Sending signals, Thread streams, Running across processes, Processors, and the tracing overview). ## Test plan - [x] `pnpm --filter mastra-docs test -- --reporter=dot` — 170 tests passed - [x] `pnpm --filter mastra-docs validate:frontmatter` — 679 files passed - [x] `pnpm --filter mastra-docs validate:reference-sidebar` — sort order passed - [x] `pnpm --filter mastra-docs validate:sidebar-docs` — all docs linked - [x] `pnpm --filter mastra-docs format:mdx:check` — 717 MDX files checked - [x] `pnpm --filter mastra-docs lint:remark` — passed - [x] `pnpm --filter mastra-docs exec oxfmt-mdx --check src/mastra-code/configuration.mdx` — passed - [x] `pnpm --filter mastra-docs build` — production build succeeded - [x] `git diff --check` — clean Docs-only change. No runtime, package, dependency, or changeset changes. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> <!-- coderabbit-ai-generated:v1 --> ## ELI5 This PR moves the Signals documentation into a set of task-based guides and updates links from the old pages. It also adds references for notifications and thread events, so readers can find details about how signals and thread updates work. ## Changes - Adds seven guides under **Extend** for the Signals model, thread streams, sending signals, state signals, notifications, providers, and multi-process setup. - Adds reference pages for notifications and thread events, and documents the `thread-history` stream chunk. - Updates the sidebars, links, and permanent redirects for the new documentation paths. - Moves Mastra Code cross-agent setup guidance to its configuration page. - Updates processor documentation with a reactive signal example and documents the `computeStateSignal` processor hook. ## Validation The PR author reports that the documentation tests, validators, formatting checks, build, and `git diff --check` passed. The reported test run had 170 tests. These results were not independently verified. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: mastracode <284800079+mastra-platform[bot]@users.noreply.github.com>
2026-10-22 16:23:52 +02:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
docs: update quickstarts (1.0) (#10429) In this PR, I’ve made a few structural and content updates to the docs. * Added a new **“Start”** page at `docs/getting-started`. * Moved all **web frameworks** from `/docs/*` to `/guides/*`. * Updated the **web framework guides** (for example, the Next.js guide) so they can be used either: * to integrate a framework like Next.js into an existing project, or * to start a new project with that framework and integrate Mastra from the beginning. * Moved all **agentic UI guides** into `/guides/*` under a new subsection called **“Build your UI”**. * Removed the **“With”** suffix from agentic UI guide titles to avoid repetition and improve readability. Other changes: * Renamed **“AI SDK”** to **“AI SDK UI”**. * Removed **Cedar OS**. * Removed the **OpenRouter framework** page and redirected it to the `models/openrouter` page. * Removed `getting-started/templates` and instead added a short note to the new **Start** page. The templates already have clear usage instructions on `/templates` and in each template repo’s README, so a top-level general guide felt redundant. ## Redirects To validate the new structure, I compiled a summary of the redirects: **Build Your UI section** (moved from `docs/frameworks/agentic-uis/`): * `/docs/frameworks/agentic-uis/ai-sdk` → `/guides/build-your-ui/ai-sdk-ui` * `/docs/frameworks/agentic-uis/assistant-ui` → `/guides/build-your-ui/assistant-ui` * `/docs/frameworks/agentic-uis/copilotkit` → `/guides/build-your-ui/copilotkit` * `/docs/frameworks/agentic-uis/cedar-os` → `/guides/build-your-ui` (file deleted, no direct replacement) * `/docs/frameworks/agentic-uis/openrouter` → `/models/gateways/openrouter` (framework page deleted, redirected to the relevant gateway docs) **Getting Started section** (moved from `docs/frameworks/web-frameworks/` and `guides/quickstarts/`): * `/docs/frameworks/web-frameworks/astro` → `/guides/getting-started/astro` * `/docs/frameworks/web-frameworks/next-js` → `/guides/getting-started/next-js` * `/docs/frameworks/web-frameworks/sveltekit` → `/guides/getting-started/sveltekit` * `/docs/frameworks/web-frameworks/vite-react` → `/guides/getting-started/vite-react` * `/docs/frameworks/servers/express` → `/guides/getting-started/express` * `/guides/guide/manual-install` → `/guides/getting-started/manual-install` * `/guides/quickstarts/nextjs` → `/guides/getting-started/next-js` * `/guides/quickstarts/standalone-server` → `/guides/getting-started/quickstart` **Other redirects:** * `/docs/getting-started/quickstart` → `/guides/getting-started/quickstart` * `/docs/getting-started/templates` → `/docs/getting-started/start` Additional notes: * All **internal MDX links** have been updated to match the new paths. * All redirects have been added to `vercel.json`. * **The redirect checker reports no redirect for Cedar OS, which is expected, as there is no suitable replacement page.** * **Update: The redirect checker reports several broken links because the redirect checker doesn't account for /v1/ - I have tested these in the preview deployment and all seems good**
2025-11-25 14:37:58 +00:00
2026-01-20 17:22:17 +01:00
docs: update quickstarts (1.0) (#10429) In this PR, I’ve made a few structural and content updates to the docs. * Added a new **“Start”** page at `docs/getting-started`. * Moved all **web frameworks** from `/docs/*` to `/guides/*`. * Updated the **web framework guides** (for example, the Next.js guide) so they can be used either: * to integrate a framework like Next.js into an existing project, or * to start a new project with that framework and integrate Mastra from the beginning. * Moved all **agentic UI guides** into `/guides/*` under a new subsection called **“Build your UI”**. * Removed the **“With”** suffix from agentic UI guide titles to avoid repetition and improve readability. Other changes: * Renamed **“AI SDK”** to **“AI SDK UI”**. * Removed **Cedar OS**. * Removed the **OpenRouter framework** page and redirected it to the `models/openrouter` page. * Removed `getting-started/templates` and instead added a short note to the new **Start** page. The templates already have clear usage instructions on `/templates` and in each template repo’s README, so a top-level general guide felt redundant. ## Redirects To validate the new structure, I compiled a summary of the redirects: **Build Your UI section** (moved from `docs/frameworks/agentic-uis/`): * `/docs/frameworks/agentic-uis/ai-sdk` → `/guides/build-your-ui/ai-sdk-ui` * `/docs/frameworks/agentic-uis/assistant-ui` → `/guides/build-your-ui/assistant-ui` * `/docs/frameworks/agentic-uis/copilotkit` → `/guides/build-your-ui/copilotkit` * `/docs/frameworks/agentic-uis/cedar-os` → `/guides/build-your-ui` (file deleted, no direct replacement) * `/docs/frameworks/agentic-uis/openrouter` → `/models/gateways/openrouter` (framework page deleted, redirected to the relevant gateway docs) **Getting Started section** (moved from `docs/frameworks/web-frameworks/` and `guides/quickstarts/`): * `/docs/frameworks/web-frameworks/astro` → `/guides/getting-started/astro` * `/docs/frameworks/web-frameworks/next-js` → `/guides/getting-started/next-js` * `/docs/frameworks/web-frameworks/sveltekit` → `/guides/getting-started/sveltekit` * `/docs/frameworks/web-frameworks/vite-react` → `/guides/getting-started/vite-react` * `/docs/frameworks/servers/express` → `/guides/getting-started/express` * `/guides/guide/manual-install` → `/guides/getting-started/manual-install` * `/guides/quickstarts/nextjs` → `/guides/getting-started/next-js` * `/guides/quickstarts/standalone-server` → `/guides/getting-started/quickstart` **Other redirects:** * `/docs/getting-started/quickstart` → `/guides/getting-started/quickstart` * `/docs/getting-started/templates` → `/docs/getting-started/start` Additional notes: * All **internal MDX links** have been updated to match the new paths. * All redirects have been added to `vercel.json`. * **The redirect checker reports no redirect for Cedar OS, which is expected, as there is no suitable replacement page.** * **Update: The redirect checker reports several broken links because the redirect checker doesn't account for /v1/ - I have tested these in the preview deployment and all seems good**
2025-11-25 14:37:58 +00:00
2026-01-20 17:22:17 +01:00
docs: update quickstarts (1.0) (#10429) In this PR, I’ve made a few structural and content updates to the docs. * Added a new **“Start”** page at `docs/getting-started`. * Moved all **web frameworks** from `/docs/*` to `/guides/*`. * Updated the **web framework guides** (for example, the Next.js guide) so they can be used either: * to integrate a framework like Next.js into an existing project, or * to start a new project with that framework and integrate Mastra from the beginning. * Moved all **agentic UI guides** into `/guides/*` under a new subsection called **“Build your UI”**. * Removed the **“With”** suffix from agentic UI guide titles to avoid repetition and improve readability. Other changes: * Renamed **“AI SDK”** to **“AI SDK UI”**. * Removed **Cedar OS**. * Removed the **OpenRouter framework** page and redirected it to the `models/openrouter` page. * Removed `getting-started/templates` and instead added a short note to the new **Start** page. The templates already have clear usage instructions on `/templates` and in each template repo’s README, so a top-level general guide felt redundant. ## Redirects To validate the new structure, I compiled a summary of the redirects: **Build Your UI section** (moved from `docs/frameworks/agentic-uis/`): * `/docs/frameworks/agentic-uis/ai-sdk` → `/guides/build-your-ui/ai-sdk-ui` * `/docs/frameworks/agentic-uis/assistant-ui` → `/guides/build-your-ui/assistant-ui` * `/docs/frameworks/agentic-uis/copilotkit` → `/guides/build-your-ui/copilotkit` * `/docs/frameworks/agentic-uis/cedar-os` → `/guides/build-your-ui` (file deleted, no direct replacement) * `/docs/frameworks/agentic-uis/openrouter` → `/models/gateways/openrouter` (framework page deleted, redirected to the relevant gateway docs) **Getting Started section** (moved from `docs/frameworks/web-frameworks/` and `guides/quickstarts/`): * `/docs/frameworks/web-frameworks/astro` → `/guides/getting-started/astro` * `/docs/frameworks/web-frameworks/next-js` → `/guides/getting-started/next-js` * `/docs/frameworks/web-frameworks/sveltekit` → `/guides/getting-started/sveltekit` * `/docs/frameworks/web-frameworks/vite-react` → `/guides/getting-started/vite-react` * `/docs/frameworks/servers/express` → `/guides/getting-started/express` * `/guides/guide/manual-install` → `/guides/getting-started/manual-install` * `/guides/quickstarts/nextjs` → `/guides/getting-started/next-js` * `/guides/quickstarts/standalone-server` → `/guides/getting-started/quickstart` **Other redirects:** * `/docs/getting-started/quickstart` → `/guides/getting-started/quickstart` * `/docs/getting-started/templates` → `/docs/getting-started/start` Additional notes: * All **internal MDX links** have been updated to match the new paths. * All redirects have been added to `vercel.json`. * **The redirect checker reports no redirect for Cedar OS, which is expected, as there is no suitable replacement page.** * **Update: The redirect checker reports several broken links because the redirect checker doesn't account for /v1/ - I have tested these in the preview deployment and all seems good**
2025-11-25 14:37:58 +00:00
2026-01-20 17:22:17 +01:00
docs: update quickstarts (1.0) (#10429) In this PR, I’ve made a few structural and content updates to the docs. * Added a new **“Start”** page at `docs/getting-started`. * Moved all **web frameworks** from `/docs/*` to `/guides/*`. * Updated the **web framework guides** (for example, the Next.js guide) so they can be used either: * to integrate a framework like Next.js into an existing project, or * to start a new project with that framework and integrate Mastra from the beginning. * Moved all **agentic UI guides** into `/guides/*` under a new subsection called **“Build your UI”**. * Removed the **“With”** suffix from agentic UI guide titles to avoid repetition and improve readability. Other changes: * Renamed **“AI SDK”** to **“AI SDK UI”**. * Removed **Cedar OS**. * Removed the **OpenRouter framework** page and redirected it to the `models/openrouter` page. * Removed `getting-started/templates` and instead added a short note to the new **Start** page. The templates already have clear usage instructions on `/templates` and in each template repo’s README, so a top-level general guide felt redundant. ## Redirects To validate the new structure, I compiled a summary of the redirects: **Build Your UI section** (moved from `docs/frameworks/agentic-uis/`): * `/docs/frameworks/agentic-uis/ai-sdk` → `/guides/build-your-ui/ai-sdk-ui` * `/docs/frameworks/agentic-uis/assistant-ui` → `/guides/build-your-ui/assistant-ui` * `/docs/frameworks/agentic-uis/copilotkit` → `/guides/build-your-ui/copilotkit` * `/docs/frameworks/agentic-uis/cedar-os` → `/guides/build-your-ui` (file deleted, no direct replacement) * `/docs/frameworks/agentic-uis/openrouter` → `/models/gateways/openrouter` (framework page deleted, redirected to the relevant gateway docs) **Getting Started section** (moved from `docs/frameworks/web-frameworks/` and `guides/quickstarts/`): * `/docs/frameworks/web-frameworks/astro` → `/guides/getting-started/astro` * `/docs/frameworks/web-frameworks/next-js` → `/guides/getting-started/next-js` * `/docs/frameworks/web-frameworks/sveltekit` → `/guides/getting-started/sveltekit` * `/docs/frameworks/web-frameworks/vite-react` → `/guides/getting-started/vite-react` * `/docs/frameworks/servers/express` → `/guides/getting-started/express` * `/guides/guide/manual-install` → `/guides/getting-started/manual-install` * `/guides/quickstarts/nextjs` → `/guides/getting-started/next-js` * `/guides/quickstarts/standalone-server` → `/guides/getting-started/quickstart` **Other redirects:** * `/docs/getting-started/quickstart` → `/guides/getting-started/quickstart` * `/docs/getting-started/templates` → `/docs/getting-started/start` Additional notes: * All **internal MDX links** have been updated to match the new paths. * All redirects have been added to `vercel.json`. * **The redirect checker reports no redirect for Cedar OS, which is expected, as there is no suitable replacement page.** * **Update: The redirect checker reports several broken links because the redirect checker doesn't account for /v1/ - I have tested these in the preview deployment and all seems good**
2025-11-25 14:37:58 +00:00
2026-01-20 17:22:17 +01:00
docs: update quickstarts (1.0) (#10429) In this PR, I’ve made a few structural and content updates to the docs. * Added a new **“Start”** page at `docs/getting-started`. * Moved all **web frameworks** from `/docs/*` to `/guides/*`. * Updated the **web framework guides** (for example, the Next.js guide) so they can be used either: * to integrate a framework like Next.js into an existing project, or * to start a new project with that framework and integrate Mastra from the beginning. * Moved all **agentic UI guides** into `/guides/*` under a new subsection called **“Build your UI”**. * Removed the **“With”** suffix from agentic UI guide titles to avoid repetition and improve readability. Other changes: * Renamed **“AI SDK”** to **“AI SDK UI”**. * Removed **Cedar OS**. * Removed the **OpenRouter framework** page and redirected it to the `models/openrouter` page. * Removed `getting-started/templates` and instead added a short note to the new **Start** page. The templates already have clear usage instructions on `/templates` and in each template repo’s README, so a top-level general guide felt redundant. ## Redirects To validate the new structure, I compiled a summary of the redirects: **Build Your UI section** (moved from `docs/frameworks/agentic-uis/`): * `/docs/frameworks/agentic-uis/ai-sdk` → `/guides/build-your-ui/ai-sdk-ui` * `/docs/frameworks/agentic-uis/assistant-ui` → `/guides/build-your-ui/assistant-ui` * `/docs/frameworks/agentic-uis/copilotkit` → `/guides/build-your-ui/copilotkit` * `/docs/frameworks/agentic-uis/cedar-os` → `/guides/build-your-ui` (file deleted, no direct replacement) * `/docs/frameworks/agentic-uis/openrouter` → `/models/gateways/openrouter` (framework page deleted, redirected to the relevant gateway docs) **Getting Started section** (moved from `docs/frameworks/web-frameworks/` and `guides/quickstarts/`): * `/docs/frameworks/web-frameworks/astro` → `/guides/getting-started/astro` * `/docs/frameworks/web-frameworks/next-js` → `/guides/getting-started/next-js` * `/docs/frameworks/web-frameworks/sveltekit` → `/guides/getting-started/sveltekit` * `/docs/frameworks/web-frameworks/vite-react` → `/guides/getting-started/vite-react` * `/docs/frameworks/servers/express` → `/guides/getting-started/express` * `/guides/guide/manual-install` → `/guides/getting-started/manual-install` * `/guides/quickstarts/nextjs` → `/guides/getting-started/next-js` * `/guides/quickstarts/standalone-server` → `/guides/getting-started/quickstart` **Other redirects:** * `/docs/getting-started/quickstart` → `/guides/getting-started/quickstart` * `/docs/getting-started/templates` → `/docs/getting-started/start` Additional notes: * All **internal MDX links** have been updated to match the new paths. * All redirects have been added to `vercel.json`. * **The redirect checker reports no redirect for Cedar OS, which is expected, as there is no suitable replacement page.** * **Update: The redirect checker reports several broken links because the redirect checker doesn't account for /v1/ - I have tested these in the preview deployment and all seems good**
2025-11-25 14:37:58 +00:00
2026-01-20 17:22:17 +01:00
docs: update quickstarts (1.0) (#10429) In this PR, I’ve made a few structural and content updates to the docs. * Added a new **“Start”** page at `docs/getting-started`. * Moved all **web frameworks** from `/docs/*` to `/guides/*`. * Updated the **web framework guides** (for example, the Next.js guide) so they can be used either: * to integrate a framework like Next.js into an existing project, or * to start a new project with that framework and integrate Mastra from the beginning. * Moved all **agentic UI guides** into `/guides/*` under a new subsection called **“Build your UI”**. * Removed the **“With”** suffix from agentic UI guide titles to avoid repetition and improve readability. Other changes: * Renamed **“AI SDK”** to **“AI SDK UI”**. * Removed **Cedar OS**. * Removed the **OpenRouter framework** page and redirected it to the `models/openrouter` page. * Removed `getting-started/templates` and instead added a short note to the new **Start** page. The templates already have clear usage instructions on `/templates` and in each template repo’s README, so a top-level general guide felt redundant. ## Redirects To validate the new structure, I compiled a summary of the redirects: **Build Your UI section** (moved from `docs/frameworks/agentic-uis/`): * `/docs/frameworks/agentic-uis/ai-sdk` → `/guides/build-your-ui/ai-sdk-ui` * `/docs/frameworks/agentic-uis/assistant-ui` → `/guides/build-your-ui/assistant-ui` * `/docs/frameworks/agentic-uis/copilotkit` → `/guides/build-your-ui/copilotkit` * `/docs/frameworks/agentic-uis/cedar-os` → `/guides/build-your-ui` (file deleted, no direct replacement) * `/docs/frameworks/agentic-uis/openrouter` → `/models/gateways/openrouter` (framework page deleted, redirected to the relevant gateway docs) **Getting Started section** (moved from `docs/frameworks/web-frameworks/` and `guides/quickstarts/`): * `/docs/frameworks/web-frameworks/astro` → `/guides/getting-started/astro` * `/docs/frameworks/web-frameworks/next-js` → `/guides/getting-started/next-js` * `/docs/frameworks/web-frameworks/sveltekit` → `/guides/getting-started/sveltekit` * `/docs/frameworks/web-frameworks/vite-react` → `/guides/getting-started/vite-react` * `/docs/frameworks/servers/express` → `/guides/getting-started/express` * `/guides/guide/manual-install` → `/guides/getting-started/manual-install` * `/guides/quickstarts/nextjs` → `/guides/getting-started/next-js` * `/guides/quickstarts/standalone-server` → `/guides/getting-started/quickstart` **Other redirects:** * `/docs/getting-started/quickstart` → `/guides/getting-started/quickstart` * `/docs/getting-started/templates` → `/docs/getting-started/start` Additional notes: * All **internal MDX links** have been updated to match the new paths. * All redirects have been added to `vercel.json`. * **The redirect checker reports no redirect for Cedar OS, which is expected, as there is no suitable replacement page.** * **Update: The redirect checker reports several broken links because the redirect checker doesn't account for /v1/ - I have tested these in the preview deployment and all seems good**
2025-11-25 14:37:58 +00:00
2026-01-20 17:22:17 +01:00
docs: update quickstarts (1.0) (#10429) In this PR, I’ve made a few structural and content updates to the docs. * Added a new **“Start”** page at `docs/getting-started`. * Moved all **web frameworks** from `/docs/*` to `/guides/*`. * Updated the **web framework guides** (for example, the Next.js guide) so they can be used either: * to integrate a framework like Next.js into an existing project, or * to start a new project with that framework and integrate Mastra from the beginning. * Moved all **agentic UI guides** into `/guides/*` under a new subsection called **“Build your UI”**. * Removed the **“With”** suffix from agentic UI guide titles to avoid repetition and improve readability. Other changes: * Renamed **“AI SDK”** to **“AI SDK UI”**. * Removed **Cedar OS**. * Removed the **OpenRouter framework** page and redirected it to the `models/openrouter` page. * Removed `getting-started/templates` and instead added a short note to the new **Start** page. The templates already have clear usage instructions on `/templates` and in each template repo’s README, so a top-level general guide felt redundant. ## Redirects To validate the new structure, I compiled a summary of the redirects: **Build Your UI section** (moved from `docs/frameworks/agentic-uis/`): * `/docs/frameworks/agentic-uis/ai-sdk` → `/guides/build-your-ui/ai-sdk-ui` * `/docs/frameworks/agentic-uis/assistant-ui` → `/guides/build-your-ui/assistant-ui` * `/docs/frameworks/agentic-uis/copilotkit` → `/guides/build-your-ui/copilotkit` * `/docs/frameworks/agentic-uis/cedar-os` → `/guides/build-your-ui` (file deleted, no direct replacement) * `/docs/frameworks/agentic-uis/openrouter` → `/models/gateways/openrouter` (framework page deleted, redirected to the relevant gateway docs) **Getting Started section** (moved from `docs/frameworks/web-frameworks/` and `guides/quickstarts/`): * `/docs/frameworks/web-frameworks/astro` → `/guides/getting-started/astro` * `/docs/frameworks/web-frameworks/next-js` → `/guides/getting-started/next-js` * `/docs/frameworks/web-frameworks/sveltekit` → `/guides/getting-started/sveltekit` * `/docs/frameworks/web-frameworks/vite-react` → `/guides/getting-started/vite-react` * `/docs/frameworks/servers/express` → `/guides/getting-started/express` * `/guides/guide/manual-install` → `/guides/getting-started/manual-install` * `/guides/quickstarts/nextjs` → `/guides/getting-started/next-js` * `/guides/quickstarts/standalone-server` → `/guides/getting-started/quickstart` **Other redirects:** * `/docs/getting-started/quickstart` → `/guides/getting-started/quickstart` * `/docs/getting-started/templates` → `/docs/getting-started/start` Additional notes: * All **internal MDX links** have been updated to match the new paths. * All redirects have been added to `vercel.json`. * **The redirect checker reports no redirect for Cedar OS, which is expected, as there is no suitable replacement page.** * **Update: The redirect checker reports several broken links because the redirect checker doesn't account for /v1/ - I have tested these in the preview deployment and all seems good**
2025-11-25 14:37:58 +00:00
2026-01-20 17:22:17 +01:00
docs: update quickstarts (1.0) (#10429) In this PR, I’ve made a few structural and content updates to the docs. * Added a new **“Start”** page at `docs/getting-started`. * Moved all **web frameworks** from `/docs/*` to `/guides/*`. * Updated the **web framework guides** (for example, the Next.js guide) so they can be used either: * to integrate a framework like Next.js into an existing project, or * to start a new project with that framework and integrate Mastra from the beginning. * Moved all **agentic UI guides** into `/guides/*` under a new subsection called **“Build your UI”**. * Removed the **“With”** suffix from agentic UI guide titles to avoid repetition and improve readability. Other changes: * Renamed **“AI SDK”** to **“AI SDK UI”**. * Removed **Cedar OS**. * Removed the **OpenRouter framework** page and redirected it to the `models/openrouter` page. * Removed `getting-started/templates` and instead added a short note to the new **Start** page. The templates already have clear usage instructions on `/templates` and in each template repo’s README, so a top-level general guide felt redundant. ## Redirects To validate the new structure, I compiled a summary of the redirects: **Build Your UI section** (moved from `docs/frameworks/agentic-uis/`): * `/docs/frameworks/agentic-uis/ai-sdk` → `/guides/build-your-ui/ai-sdk-ui` * `/docs/frameworks/agentic-uis/assistant-ui` → `/guides/build-your-ui/assistant-ui` * `/docs/frameworks/agentic-uis/copilotkit` → `/guides/build-your-ui/copilotkit` * `/docs/frameworks/agentic-uis/cedar-os` → `/guides/build-your-ui` (file deleted, no direct replacement) * `/docs/frameworks/agentic-uis/openrouter` → `/models/gateways/openrouter` (framework page deleted, redirected to the relevant gateway docs) **Getting Started section** (moved from `docs/frameworks/web-frameworks/` and `guides/quickstarts/`): * `/docs/frameworks/web-frameworks/astro` → `/guides/getting-started/astro` * `/docs/frameworks/web-frameworks/next-js` → `/guides/getting-started/next-js` * `/docs/frameworks/web-frameworks/sveltekit` → `/guides/getting-started/sveltekit` * `/docs/frameworks/web-frameworks/vite-react` → `/guides/getting-started/vite-react` * `/docs/frameworks/servers/express` → `/guides/getting-started/express` * `/guides/guide/manual-install` → `/guides/getting-started/manual-install` * `/guides/quickstarts/nextjs` → `/guides/getting-started/next-js` * `/guides/quickstarts/standalone-server` → `/guides/getting-started/quickstart` **Other redirects:** * `/docs/getting-started/quickstart` → `/guides/getting-started/quickstart` * `/docs/getting-started/templates` → `/docs/getting-started/start` Additional notes: * All **internal MDX links** have been updated to match the new paths. * All redirects have been added to `vercel.json`. * **The redirect checker reports no redirect for Cedar OS, which is expected, as there is no suitable replacement page.** * **Update: The redirect checker reports several broken links because the redirect checker doesn't account for /v1/ - I have tested these in the preview deployment and all seems good**
2025-11-25 14:37:58 +00:00
2026-01-20 17:22:17 +01:00
docs: update quickstarts (1.0) (#10429) In this PR, I’ve made a few structural and content updates to the docs. * Added a new **“Start”** page at `docs/getting-started`. * Moved all **web frameworks** from `/docs/*` to `/guides/*`. * Updated the **web framework guides** (for example, the Next.js guide) so they can be used either: * to integrate a framework like Next.js into an existing project, or * to start a new project with that framework and integrate Mastra from the beginning. * Moved all **agentic UI guides** into `/guides/*` under a new subsection called **“Build your UI”**. * Removed the **“With”** suffix from agentic UI guide titles to avoid repetition and improve readability. Other changes: * Renamed **“AI SDK”** to **“AI SDK UI”**. * Removed **Cedar OS**. * Removed the **OpenRouter framework** page and redirected it to the `models/openrouter` page. * Removed `getting-started/templates` and instead added a short note to the new **Start** page. The templates already have clear usage instructions on `/templates` and in each template repo’s README, so a top-level general guide felt redundant. ## Redirects To validate the new structure, I compiled a summary of the redirects: **Build Your UI section** (moved from `docs/frameworks/agentic-uis/`): * `/docs/frameworks/agentic-uis/ai-sdk` → `/guides/build-your-ui/ai-sdk-ui` * `/docs/frameworks/agentic-uis/assistant-ui` → `/guides/build-your-ui/assistant-ui` * `/docs/frameworks/agentic-uis/copilotkit` → `/guides/build-your-ui/copilotkit` * `/docs/frameworks/agentic-uis/cedar-os` → `/guides/build-your-ui` (file deleted, no direct replacement) * `/docs/frameworks/agentic-uis/openrouter` → `/models/gateways/openrouter` (framework page deleted, redirected to the relevant gateway docs) **Getting Started section** (moved from `docs/frameworks/web-frameworks/` and `guides/quickstarts/`): * `/docs/frameworks/web-frameworks/astro` → `/guides/getting-started/astro` * `/docs/frameworks/web-frameworks/next-js` → `/guides/getting-started/next-js` * `/docs/frameworks/web-frameworks/sveltekit` → `/guides/getting-started/sveltekit` * `/docs/frameworks/web-frameworks/vite-react` → `/guides/getting-started/vite-react` * `/docs/frameworks/servers/express` → `/guides/getting-started/express` * `/guides/guide/manual-install` → `/guides/getting-started/manual-install` * `/guides/quickstarts/nextjs` → `/guides/getting-started/next-js` * `/guides/quickstarts/standalone-server` → `/guides/getting-started/quickstart` **Other redirects:** * `/docs/getting-started/quickstart` → `/guides/getting-started/quickstart` * `/docs/getting-started/templates` → `/docs/getting-started/start` Additional notes: * All **internal MDX links** have been updated to match the new paths. * All redirects have been added to `vercel.json`. * **The redirect checker reports no redirect for Cedar OS, which is expected, as there is no suitable replacement page.** * **Update: The redirect checker reports several broken links because the redirect checker doesn't account for /v1/ - I have tested these in the preview deployment and all seems good**
2025-11-25 14:37:58 +00:00
2026-01-20 17:22:17 +01:00
docs: update quickstarts (1.0) (#10429) In this PR, I’ve made a few structural and content updates to the docs. * Added a new **“Start”** page at `docs/getting-started`. * Moved all **web frameworks** from `/docs/*` to `/guides/*`. * Updated the **web framework guides** (for example, the Next.js guide) so they can be used either: * to integrate a framework like Next.js into an existing project, or * to start a new project with that framework and integrate Mastra from the beginning. * Moved all **agentic UI guides** into `/guides/*` under a new subsection called **“Build your UI”**. * Removed the **“With”** suffix from agentic UI guide titles to avoid repetition and improve readability. Other changes: * Renamed **“AI SDK”** to **“AI SDK UI”**. * Removed **Cedar OS**. * Removed the **OpenRouter framework** page and redirected it to the `models/openrouter` page. * Removed `getting-started/templates` and instead added a short note to the new **Start** page. The templates already have clear usage instructions on `/templates` and in each template repo’s README, so a top-level general guide felt redundant. ## Redirects To validate the new structure, I compiled a summary of the redirects: **Build Your UI section** (moved from `docs/frameworks/agentic-uis/`): * `/docs/frameworks/agentic-uis/ai-sdk` → `/guides/build-your-ui/ai-sdk-ui` * `/docs/frameworks/agentic-uis/assistant-ui` → `/guides/build-your-ui/assistant-ui` * `/docs/frameworks/agentic-uis/copilotkit` → `/guides/build-your-ui/copilotkit` * `/docs/frameworks/agentic-uis/cedar-os` → `/guides/build-your-ui` (file deleted, no direct replacement) * `/docs/frameworks/agentic-uis/openrouter` → `/models/gateways/openrouter` (framework page deleted, redirected to the relevant gateway docs) **Getting Started section** (moved from `docs/frameworks/web-frameworks/` and `guides/quickstarts/`): * `/docs/frameworks/web-frameworks/astro` → `/guides/getting-started/astro` * `/docs/frameworks/web-frameworks/next-js` → `/guides/getting-started/next-js` * `/docs/frameworks/web-frameworks/sveltekit` → `/guides/getting-started/sveltekit` * `/docs/frameworks/web-frameworks/vite-react` → `/guides/getting-started/vite-react` * `/docs/frameworks/servers/express` → `/guides/getting-started/express` * `/guides/guide/manual-install` → `/guides/getting-started/manual-install` * `/guides/quickstarts/nextjs` → `/guides/getting-started/next-js` * `/guides/quickstarts/standalone-server` → `/guides/getting-started/quickstart` **Other redirects:** * `/docs/getting-started/quickstart` → `/guides/getting-started/quickstart` * `/docs/getting-started/templates` → `/docs/getting-started/start` Additional notes: * All **internal MDX links** have been updated to match the new paths. * All redirects have been added to `vercel.json`. * **The redirect checker reports no redirect for Cedar OS, which is expected, as there is no suitable replacement page.** * **Update: The redirect checker reports several broken links because the redirect checker doesn't account for /v1/ - I have tested these in the preview deployment and all seems good**
2025-11-25 14:37:58 +00:00
2026-01-20 17:22:17 +01:00
docs: update quickstarts (1.0) (#10429) In this PR, I’ve made a few structural and content updates to the docs. * Added a new **“Start”** page at `docs/getting-started`. * Moved all **web frameworks** from `/docs/*` to `/guides/*`. * Updated the **web framework guides** (for example, the Next.js guide) so they can be used either: * to integrate a framework like Next.js into an existing project, or * to start a new project with that framework and integrate Mastra from the beginning. * Moved all **agentic UI guides** into `/guides/*` under a new subsection called **“Build your UI”**. * Removed the **“With”** suffix from agentic UI guide titles to avoid repetition and improve readability. Other changes: * Renamed **“AI SDK”** to **“AI SDK UI”**. * Removed **Cedar OS**. * Removed the **OpenRouter framework** page and redirected it to the `models/openrouter` page. * Removed `getting-started/templates` and instead added a short note to the new **Start** page. The templates already have clear usage instructions on `/templates` and in each template repo’s README, so a top-level general guide felt redundant. ## Redirects To validate the new structure, I compiled a summary of the redirects: **Build Your UI section** (moved from `docs/frameworks/agentic-uis/`): * `/docs/frameworks/agentic-uis/ai-sdk` → `/guides/build-your-ui/ai-sdk-ui` * `/docs/frameworks/agentic-uis/assistant-ui` → `/guides/build-your-ui/assistant-ui` * `/docs/frameworks/agentic-uis/copilotkit` → `/guides/build-your-ui/copilotkit` * `/docs/frameworks/agentic-uis/cedar-os` → `/guides/build-your-ui` (file deleted, no direct replacement) * `/docs/frameworks/agentic-uis/openrouter` → `/models/gateways/openrouter` (framework page deleted, redirected to the relevant gateway docs) **Getting Started section** (moved from `docs/frameworks/web-frameworks/` and `guides/quickstarts/`): * `/docs/frameworks/web-frameworks/astro` → `/guides/getting-started/astro` * `/docs/frameworks/web-frameworks/next-js` → `/guides/getting-started/next-js` * `/docs/frameworks/web-frameworks/sveltekit` → `/guides/getting-started/sveltekit` * `/docs/frameworks/web-frameworks/vite-react` → `/guides/getting-started/vite-react` * `/docs/frameworks/servers/express` → `/guides/getting-started/express` * `/guides/guide/manual-install` → `/guides/getting-started/manual-install` * `/guides/quickstarts/nextjs` → `/guides/getting-started/next-js` * `/guides/quickstarts/standalone-server` → `/guides/getting-started/quickstart` **Other redirects:** * `/docs/getting-started/quickstart` → `/guides/getting-started/quickstart` * `/docs/getting-started/templates` → `/docs/getting-started/start` Additional notes: * All **internal MDX links** have been updated to match the new paths. * All redirects have been added to `vercel.json`. * **The redirect checker reports no redirect for Cedar OS, which is expected, as there is no suitable replacement page.** * **Update: The redirect checker reports several broken links because the redirect checker doesn't account for /v1/ - I have tested these in the preview deployment and all seems good**
2025-11-25 14:37:58 +00:00
2026-01-20 17:22:17 +01:00
docs: update quickstarts (1.0) (#10429) In this PR, I’ve made a few structural and content updates to the docs. * Added a new **“Start”** page at `docs/getting-started`. * Moved all **web frameworks** from `/docs/*` to `/guides/*`. * Updated the **web framework guides** (for example, the Next.js guide) so they can be used either: * to integrate a framework like Next.js into an existing project, or * to start a new project with that framework and integrate Mastra from the beginning. * Moved all **agentic UI guides** into `/guides/*` under a new subsection called **“Build your UI”**. * Removed the **“With”** suffix from agentic UI guide titles to avoid repetition and improve readability. Other changes: * Renamed **“AI SDK”** to **“AI SDK UI”**. * Removed **Cedar OS**. * Removed the **OpenRouter framework** page and redirected it to the `models/openrouter` page. * Removed `getting-started/templates` and instead added a short note to the new **Start** page. The templates already have clear usage instructions on `/templates` and in each template repo’s README, so a top-level general guide felt redundant. ## Redirects To validate the new structure, I compiled a summary of the redirects: **Build Your UI section** (moved from `docs/frameworks/agentic-uis/`): * `/docs/frameworks/agentic-uis/ai-sdk` → `/guides/build-your-ui/ai-sdk-ui` * `/docs/frameworks/agentic-uis/assistant-ui` → `/guides/build-your-ui/assistant-ui` * `/docs/frameworks/agentic-uis/copilotkit` → `/guides/build-your-ui/copilotkit` * `/docs/frameworks/agentic-uis/cedar-os` → `/guides/build-your-ui` (file deleted, no direct replacement) * `/docs/frameworks/agentic-uis/openrouter` → `/models/gateways/openrouter` (framework page deleted, redirected to the relevant gateway docs) **Getting Started section** (moved from `docs/frameworks/web-frameworks/` and `guides/quickstarts/`): * `/docs/frameworks/web-frameworks/astro` → `/guides/getting-started/astro` * `/docs/frameworks/web-frameworks/next-js` → `/guides/getting-started/next-js` * `/docs/frameworks/web-frameworks/sveltekit` → `/guides/getting-started/sveltekit` * `/docs/frameworks/web-frameworks/vite-react` → `/guides/getting-started/vite-react` * `/docs/frameworks/servers/express` → `/guides/getting-started/express` * `/guides/guide/manual-install` → `/guides/getting-started/manual-install` * `/guides/quickstarts/nextjs` → `/guides/getting-started/next-js` * `/guides/quickstarts/standalone-server` → `/guides/getting-started/quickstart` **Other redirects:** * `/docs/getting-started/quickstart` → `/guides/getting-started/quickstart` * `/docs/getting-started/templates` → `/docs/getting-started/start` Additional notes: * All **internal MDX links** have been updated to match the new paths. * All redirects have been added to `vercel.json`. * **The redirect checker reports no redirect for Cedar OS, which is expected, as there is no suitable replacement page.** * **Update: The redirect checker reports several broken links because the redirect checker doesn't account for /v1/ - I have tested these in the preview deployment and all seems good**
2025-11-25 14:37:58 +00:00
2026-01-20 17:22:17 +01:00
2026-08-12 14:17:06 +01:00
docs: update quickstarts (1.0) (#10429) In this PR, I’ve made a few structural and content updates to the docs. * Added a new **“Start”** page at `docs/getting-started`. * Moved all **web frameworks** from `/docs/*` to `/guides/*`. * Updated the **web framework guides** (for example, the Next.js guide) so they can be used either: * to integrate a framework like Next.js into an existing project, or * to start a new project with that framework and integrate Mastra from the beginning. * Moved all **agentic UI guides** into `/guides/*` under a new subsection called **“Build your UI”**. * Removed the **“With”** suffix from agentic UI guide titles to avoid repetition and improve readability. Other changes: * Renamed **“AI SDK”** to **“AI SDK UI”**. * Removed **Cedar OS**. * Removed the **OpenRouter framework** page and redirected it to the `models/openrouter` page. * Removed `getting-started/templates` and instead added a short note to the new **Start** page. The templates already have clear usage instructions on `/templates` and in each template repo’s README, so a top-level general guide felt redundant. ## Redirects To validate the new structure, I compiled a summary of the redirects: **Build Your UI section** (moved from `docs/frameworks/agentic-uis/`): * `/docs/frameworks/agentic-uis/ai-sdk` → `/guides/build-your-ui/ai-sdk-ui` * `/docs/frameworks/agentic-uis/assistant-ui` → `/guides/build-your-ui/assistant-ui` * `/docs/frameworks/agentic-uis/copilotkit` → `/guides/build-your-ui/copilotkit` * `/docs/frameworks/agentic-uis/cedar-os` → `/guides/build-your-ui` (file deleted, no direct replacement) * `/docs/frameworks/agentic-uis/openrouter` → `/models/gateways/openrouter` (framework page deleted, redirected to the relevant gateway docs) **Getting Started section** (moved from `docs/frameworks/web-frameworks/` and `guides/quickstarts/`): * `/docs/frameworks/web-frameworks/astro` → `/guides/getting-started/astro` * `/docs/frameworks/web-frameworks/next-js` → `/guides/getting-started/next-js` * `/docs/frameworks/web-frameworks/sveltekit` → `/guides/getting-started/sveltekit` * `/docs/frameworks/web-frameworks/vite-react` → `/guides/getting-started/vite-react` * `/docs/frameworks/servers/express` → `/guides/getting-started/express` * `/guides/guide/manual-install` → `/guides/getting-started/manual-install` * `/guides/quickstarts/nextjs` → `/guides/getting-started/next-js` * `/guides/quickstarts/standalone-server` → `/guides/getting-started/quickstart` **Other redirects:** * `/docs/getting-started/quickstart` → `/guides/getting-started/quickstart` * `/docs/getting-started/templates` → `/docs/getting-started/start` Additional notes: * All **internal MDX links** have been updated to match the new paths. * All redirects have been added to `vercel.json`. * **The redirect checker reports no redirect for Cedar OS, which is expected, as there is no suitable replacement page.** * **Update: The redirect checker reports several broken links because the redirect checker doesn't account for /v1/ - I have tested these in the preview deployment and all seems good**
2025-11-25 14:37:58 +00:00
2026-01-20 17:22:17 +01:00
2026-08-12 14:17:06 +01:00
docs: update quickstarts (1.0) (#10429) In this PR, I’ve made a few structural and content updates to the docs. * Added a new **“Start”** page at `docs/getting-started`. * Moved all **web frameworks** from `/docs/*` to `/guides/*`. * Updated the **web framework guides** (for example, the Next.js guide) so they can be used either: * to integrate a framework like Next.js into an existing project, or * to start a new project with that framework and integrate Mastra from the beginning. * Moved all **agentic UI guides** into `/guides/*` under a new subsection called **“Build your UI”**. * Removed the **“With”** suffix from agentic UI guide titles to avoid repetition and improve readability. Other changes: * Renamed **“AI SDK”** to **“AI SDK UI”**. * Removed **Cedar OS**. * Removed the **OpenRouter framework** page and redirected it to the `models/openrouter` page. * Removed `getting-started/templates` and instead added a short note to the new **Start** page. The templates already have clear usage instructions on `/templates` and in each template repo’s README, so a top-level general guide felt redundant. ## Redirects To validate the new structure, I compiled a summary of the redirects: **Build Your UI section** (moved from `docs/frameworks/agentic-uis/`): * `/docs/frameworks/agentic-uis/ai-sdk` → `/guides/build-your-ui/ai-sdk-ui` * `/docs/frameworks/agentic-uis/assistant-ui` → `/guides/build-your-ui/assistant-ui` * `/docs/frameworks/agentic-uis/copilotkit` → `/guides/build-your-ui/copilotkit` * `/docs/frameworks/agentic-uis/cedar-os` → `/guides/build-your-ui` (file deleted, no direct replacement) * `/docs/frameworks/agentic-uis/openrouter` → `/models/gateways/openrouter` (framework page deleted, redirected to the relevant gateway docs) **Getting Started section** (moved from `docs/frameworks/web-frameworks/` and `guides/quickstarts/`): * `/docs/frameworks/web-frameworks/astro` → `/guides/getting-started/astro` * `/docs/frameworks/web-frameworks/next-js` → `/guides/getting-started/next-js` * `/docs/frameworks/web-frameworks/sveltekit` → `/guides/getting-started/sveltekit` * `/docs/frameworks/web-frameworks/vite-react` → `/guides/getting-started/vite-react` * `/docs/frameworks/servers/express` → `/guides/getting-started/express` * `/guides/guide/manual-install` → `/guides/getting-started/manual-install` * `/guides/quickstarts/nextjs` → `/guides/getting-started/next-js` * `/guides/quickstarts/standalone-server` → `/guides/getting-started/quickstart` **Other redirects:** * `/docs/getting-started/quickstart` → `/guides/getting-started/quickstart` * `/docs/getting-started/templates` → `/docs/getting-started/start` Additional notes: * All **internal MDX links** have been updated to match the new paths. * All redirects have been added to `vercel.json`. * **The redirect checker reports no redirect for Cedar OS, which is expected, as there is no suitable replacement page.** * **Update: The redirect checker reports several broken links because the redirect checker doesn't account for /v1/ - I have tested these in the preview deployment and all seems good**
2025-11-25 14:37:58 +00:00
2026-01-20 17:22:17 +01:00
docs: update quickstarts (1.0) (#10429) In this PR, I’ve made a few structural and content updates to the docs. * Added a new **“Start”** page at `docs/getting-started`. * Moved all **web frameworks** from `/docs/*` to `/guides/*`. * Updated the **web framework guides** (for example, the Next.js guide) so they can be used either: * to integrate a framework like Next.js into an existing project, or * to start a new project with that framework and integrate Mastra from the beginning. * Moved all **agentic UI guides** into `/guides/*` under a new subsection called **“Build your UI”**. * Removed the **“With”** suffix from agentic UI guide titles to avoid repetition and improve readability. Other changes: * Renamed **“AI SDK”** to **“AI SDK UI”**. * Removed **Cedar OS**. * Removed the **OpenRouter framework** page and redirected it to the `models/openrouter` page. * Removed `getting-started/templates` and instead added a short note to the new **Start** page. The templates already have clear usage instructions on `/templates` and in each template repo’s README, so a top-level general guide felt redundant. ## Redirects To validate the new structure, I compiled a summary of the redirects: **Build Your UI section** (moved from `docs/frameworks/agentic-uis/`): * `/docs/frameworks/agentic-uis/ai-sdk` → `/guides/build-your-ui/ai-sdk-ui` * `/docs/frameworks/agentic-uis/assistant-ui` → `/guides/build-your-ui/assistant-ui` * `/docs/frameworks/agentic-uis/copilotkit` → `/guides/build-your-ui/copilotkit` * `/docs/frameworks/agentic-uis/cedar-os` → `/guides/build-your-ui` (file deleted, no direct replacement) * `/docs/frameworks/agentic-uis/openrouter` → `/models/gateways/openrouter` (framework page deleted, redirected to the relevant gateway docs) **Getting Started section** (moved from `docs/frameworks/web-frameworks/` and `guides/quickstarts/`): * `/docs/frameworks/web-frameworks/astro` → `/guides/getting-started/astro` * `/docs/frameworks/web-frameworks/next-js` → `/guides/getting-started/next-js` * `/docs/frameworks/web-frameworks/sveltekit` → `/guides/getting-started/sveltekit` * `/docs/frameworks/web-frameworks/vite-react` → `/guides/getting-started/vite-react` * `/docs/frameworks/servers/express` → `/guides/getting-started/express` * `/guides/guide/manual-install` → `/guides/getting-started/manual-install` * `/guides/quickstarts/nextjs` → `/guides/getting-started/next-js` * `/guides/quickstarts/standalone-server` → `/guides/getting-started/quickstart` **Other redirects:** * `/docs/getting-started/quickstart` → `/guides/getting-started/quickstart` * `/docs/getting-started/templates` → `/docs/getting-started/start` Additional notes: * All **internal MDX links** have been updated to match the new paths. * All redirects have been added to `vercel.json`. * **The redirect checker reports no redirect for Cedar OS, which is expected, as there is no suitable replacement page.** * **Update: The redirect checker reports several broken links because the redirect checker doesn't account for /v1/ - I have tested these in the preview deployment and all seems good**
2025-11-25 14:37:58 +00:00
docs: death to examples (#10493) * Renamed `index.md` to `README.md` for the memory examples, so it renders better on GitHub.com * Moved memory examples into `mastra-ai/mastra/examples`. * Removed the image analysis example; renamed the Agents section heading from “Working with images” to “Analyzing images” and added a redirect. * Moved the WhatsApp example under Guides and added a redirect. * Removed the “evals running in CI” example and added a redirect to the equivalent docs section. * Removed the model router tab from the Agents documentation. * Promoted the agent stopping condition content into its own H2 sections so it is no longer incorrectly nested under the images content. * Renamed “Human in the loop” to “Human-in-the-loop” for consistency. * Renamed “Tools & MCP” to “Tools” to match the latest 0.x terminology. * Updated the Guides overview, replacing the outdated cards with a short paragraph as a temporary improvement. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized agents documentation structure with dedicated Installation section; renamed "Working with images" to "Analyzing images" * Removed standalone image analysis and CI evaluation example pages * Updated example links, redirects, and sidebar navigation * Refined content wording and structure across multiple guides for clarity <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Lennart <lekoarts@gmail.com>
2025-11-26 10:39:03 +00:00
2026-01-20 17:22:17 +01:00
docs: death to examples (#10493) * Renamed `index.md` to `README.md` for the memory examples, so it renders better on GitHub.com * Moved memory examples into `mastra-ai/mastra/examples`. * Removed the image analysis example; renamed the Agents section heading from “Working with images” to “Analyzing images” and added a redirect. * Moved the WhatsApp example under Guides and added a redirect. * Removed the “evals running in CI” example and added a redirect to the equivalent docs section. * Removed the model router tab from the Agents documentation. * Promoted the agent stopping condition content into its own H2 sections so it is no longer incorrectly nested under the images content. * Renamed “Human in the loop” to “Human-in-the-loop” for consistency. * Renamed “Tools & MCP” to “Tools” to match the latest 0.x terminology. * Updated the Guides overview, replacing the outdated cards with a short paragraph as a temporary improvement. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized agents documentation structure with dedicated Installation section; renamed "Working with images" to "Analyzing images" * Removed standalone image analysis and CI evaluation example pages * Updated example links, redirects, and sidebar navigation * Refined content wording and structure across multiple guides for clarity <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Lennart <lekoarts@gmail.com>
2025-11-26 10:39:03 +00:00
2026-01-20 17:22:17 +01:00
docs: death to examples (#10493) * Renamed `index.md` to `README.md` for the memory examples, so it renders better on GitHub.com * Moved memory examples into `mastra-ai/mastra/examples`. * Removed the image analysis example; renamed the Agents section heading from “Working with images” to “Analyzing images” and added a redirect. * Moved the WhatsApp example under Guides and added a redirect. * Removed the “evals running in CI” example and added a redirect to the equivalent docs section. * Removed the model router tab from the Agents documentation. * Promoted the agent stopping condition content into its own H2 sections so it is no longer incorrectly nested under the images content. * Renamed “Human in the loop” to “Human-in-the-loop” for consistency. * Renamed “Tools & MCP” to “Tools” to match the latest 0.x terminology. * Updated the Guides overview, replacing the outdated cards with a short paragraph as a temporary improvement. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized agents documentation structure with dedicated Installation section; renamed "Working with images" to "Analyzing images" * Removed standalone image analysis and CI evaluation example pages * Updated example links, redirects, and sidebar navigation * Refined content wording and structure across multiple guides for clarity <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Lennart <lekoarts@gmail.com>
2025-11-26 10:39:03 +00:00
2026-01-20 17:22:17 +01:00
docs: death to examples (#10493) * Renamed `index.md` to `README.md` for the memory examples, so it renders better on GitHub.com * Moved memory examples into `mastra-ai/mastra/examples`. * Removed the image analysis example; renamed the Agents section heading from “Working with images” to “Analyzing images” and added a redirect. * Moved the WhatsApp example under Guides and added a redirect. * Removed the “evals running in CI” example and added a redirect to the equivalent docs section. * Removed the model router tab from the Agents documentation. * Promoted the agent stopping condition content into its own H2 sections so it is no longer incorrectly nested under the images content. * Renamed “Human in the loop” to “Human-in-the-loop” for consistency. * Renamed “Tools & MCP” to “Tools” to match the latest 0.x terminology. * Updated the Guides overview, replacing the outdated cards with a short paragraph as a temporary improvement. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized agents documentation structure with dedicated Installation section; renamed "Working with images" to "Analyzing images" * Removed standalone image analysis and CI evaluation example pages * Updated example links, redirects, and sidebar navigation * Refined content wording and structure across multiple guides for clarity <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Lennart <lekoarts@gmail.com>
2025-11-26 10:39:03 +00:00
2026-01-20 17:22:17 +01:00
docs: death to examples (#10493) * Renamed `index.md` to `README.md` for the memory examples, so it renders better on GitHub.com * Moved memory examples into `mastra-ai/mastra/examples`. * Removed the image analysis example; renamed the Agents section heading from “Working with images” to “Analyzing images” and added a redirect. * Moved the WhatsApp example under Guides and added a redirect. * Removed the “evals running in CI” example and added a redirect to the equivalent docs section. * Removed the model router tab from the Agents documentation. * Promoted the agent stopping condition content into its own H2 sections so it is no longer incorrectly nested under the images content. * Renamed “Human in the loop” to “Human-in-the-loop” for consistency. * Renamed “Tools & MCP” to “Tools” to match the latest 0.x terminology. * Updated the Guides overview, replacing the outdated cards with a short paragraph as a temporary improvement. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized agents documentation structure with dedicated Installation section; renamed "Working with images" to "Analyzing images" * Removed standalone image analysis and CI evaluation example pages * Updated example links, redirects, and sidebar navigation * Refined content wording and structure across multiple guides for clarity <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Lennart <lekoarts@gmail.com>
2025-11-26 10:39:03 +00:00
2026-01-20 17:22:17 +01:00
docs: death to examples (#10493) * Renamed `index.md` to `README.md` for the memory examples, so it renders better on GitHub.com * Moved memory examples into `mastra-ai/mastra/examples`. * Removed the image analysis example; renamed the Agents section heading from “Working with images” to “Analyzing images” and added a redirect. * Moved the WhatsApp example under Guides and added a redirect. * Removed the “evals running in CI” example and added a redirect to the equivalent docs section. * Removed the model router tab from the Agents documentation. * Promoted the agent stopping condition content into its own H2 sections so it is no longer incorrectly nested under the images content. * Renamed “Human in the loop” to “Human-in-the-loop” for consistency. * Renamed “Tools & MCP” to “Tools” to match the latest 0.x terminology. * Updated the Guides overview, replacing the outdated cards with a short paragraph as a temporary improvement. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized agents documentation structure with dedicated Installation section; renamed "Working with images" to "Analyzing images" * Removed standalone image analysis and CI evaluation example pages * Updated example links, redirects, and sidebar navigation * Refined content wording and structure across multiple guides for clarity <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Lennart <lekoarts@gmail.com>
2025-11-26 10:39:03 +00:00
2026-01-20 17:22:17 +01:00
docs: death to examples (#10493) * Renamed `index.md` to `README.md` for the memory examples, so it renders better on GitHub.com * Moved memory examples into `mastra-ai/mastra/examples`. * Removed the image analysis example; renamed the Agents section heading from “Working with images” to “Analyzing images” and added a redirect. * Moved the WhatsApp example under Guides and added a redirect. * Removed the “evals running in CI” example and added a redirect to the equivalent docs section. * Removed the model router tab from the Agents documentation. * Promoted the agent stopping condition content into its own H2 sections so it is no longer incorrectly nested under the images content. * Renamed “Human in the loop” to “Human-in-the-loop” for consistency. * Renamed “Tools & MCP” to “Tools” to match the latest 0.x terminology. * Updated the Guides overview, replacing the outdated cards with a short paragraph as a temporary improvement. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized agents documentation structure with dedicated Installation section; renamed "Working with images" to "Analyzing images" * Removed standalone image analysis and CI evaluation example pages * Updated example links, redirects, and sidebar navigation * Refined content wording and structure across multiple guides for clarity <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Lennart <lekoarts@gmail.com>
2025-11-26 10:39:03 +00:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-08-17 12:17:06 +02:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
feat(memory): add listThreads method with flexible filtering (#11832) ## Summary Implements the new `listThreads` method across all storage adapters, based on [PR #10662](https://github.com/mastra-ai/mastra/pull/10662). closes #4333 ### Features - **Flexible filtering**: Optional `resourceId` and `metadata` filters (both optional, unlike `listThreadsByResourceId`) - **Metadata filtering**: AND logic - all specified key-value pairs must match - **Pagination & sorting**: Same options as `listThreadsByResourceId` ### Security Improvements 🔒 - **SQL Injection Prevention**: Added `validateMetadataKeys()` to prevent SQL injection via malicious metadata keys - Keys must match pattern: `^[a-zA-Z_][a-zA-Z0-9_]*$` - Maximum key length of 128 characters enforced - **Integer Overflow Protection**: Added `validatePagination()` to prevent overflow attacks on page parameters ### Storage Adapters Updated (11 total) | Category | Stores | |----------|--------| | SQL-based | PostgreSQL, LibSQL, MSSQL, Cloudflare D1, ClickHouse | | NoSQL/KV | MongoDB, DynamoDB, Upstash, Cloudflare KV, Convex, Lance | ### Usage Example ```typescript // Filter by resourceId only await memory.listThreads({ filter: { resourceId: 'user-123' } }); // Filter by metadata only await memory.listThreads({ filter: { metadata: { category: 'support' } } }); // Filter by both (AND logic) await memory.listThreads({ filter: { resourceId: 'user-123', metadata: { priority: 'high', status: 'open' } }, orderBy: { field: 'updatedAt', direction: 'DESC' }, page: 0, perPage: 20 }); ``` ## Test Plan - [x] Type checking passes across all packages - [x] Comprehensive test coverage for filtering, pagination, and sorting - [x] Run full test suite - [x] Verify SQL injection prevention works as expected - [x] Test with edge cases (empty metadata, special characters rejected) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Unified listThreads API: optional resourceId and metadata filters (AND semantics), pagination with fetch-all option, and ordering support. * **Improvements** * Stricter pagination validation, clearer page/perPage/total/hasMore semantics, and metadata key/value validation with richer error/context. * Added deep JSON equality utility for comparisons. * **Documentation** * Updated guides, references, examples, and redirects for the new listing API. * **Tests & Migration** * Expanded test coverage and a codemod to assist migration. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Lennart <lekoarts@gmail.com>
2026-01-19 14:50:30 -05:00
2026-01-20 17:22:17 +01:00
feat(memory): add listThreads method with flexible filtering (#11832) ## Summary Implements the new `listThreads` method across all storage adapters, based on [PR #10662](https://github.com/mastra-ai/mastra/pull/10662). closes #4333 ### Features - **Flexible filtering**: Optional `resourceId` and `metadata` filters (both optional, unlike `listThreadsByResourceId`) - **Metadata filtering**: AND logic - all specified key-value pairs must match - **Pagination & sorting**: Same options as `listThreadsByResourceId` ### Security Improvements 🔒 - **SQL Injection Prevention**: Added `validateMetadataKeys()` to prevent SQL injection via malicious metadata keys - Keys must match pattern: `^[a-zA-Z_][a-zA-Z0-9_]*$` - Maximum key length of 128 characters enforced - **Integer Overflow Protection**: Added `validatePagination()` to prevent overflow attacks on page parameters ### Storage Adapters Updated (11 total) | Category | Stores | |----------|--------| | SQL-based | PostgreSQL, LibSQL, MSSQL, Cloudflare D1, ClickHouse | | NoSQL/KV | MongoDB, DynamoDB, Upstash, Cloudflare KV, Convex, Lance | ### Usage Example ```typescript // Filter by resourceId only await memory.listThreads({ filter: { resourceId: 'user-123' } }); // Filter by metadata only await memory.listThreads({ filter: { metadata: { category: 'support' } } }); // Filter by both (AND logic) await memory.listThreads({ filter: { resourceId: 'user-123', metadata: { priority: 'high', status: 'open' } }, orderBy: { field: 'updatedAt', direction: 'DESC' }, page: 0, perPage: 20 }); ``` ## Test Plan - [x] Type checking passes across all packages - [x] Comprehensive test coverage for filtering, pagination, and sorting - [x] Run full test suite - [x] Verify SQL injection prevention works as expected - [x] Test with edge cases (empty metadata, special characters rejected) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Unified listThreads API: optional resourceId and metadata filters (AND semantics), pagination with fetch-all option, and ordering support. * **Improvements** * Stricter pagination validation, clearer page/perPage/total/hasMore semantics, and metadata key/value validation with richer error/context. * Added deep JSON equality utility for comparisons. * **Documentation** * Updated guides, references, examples, and redirects for the new listing API. * **Tests & Migration** * Expanded test coverage and a codemod to assist migration. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Lennart <lekoarts@gmail.com>
2026-01-19 14:50:30 -05:00
2026-01-20 17:22:17 +01:00
2026-08-17 12:17:06 +02:00
2026-01-20 17:22:17 +01:00
2026-08-17 12:17:06 +02:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
docs: move Mastra Cloud to top-level docs category (#11177) Changes: * Rename the "Experimental" label to "Beta" across CSS and components, to match our terminology and better communicate stability (with room to add "Alpha" later). * Promote **Mastra Cloud** to its own top‑level documentation category (rather than under Deployment), reflecting it as a discrete product and improving discoverability. * Move Cloud Provider deployment guides (e.g. Vercel, Netlify) into `/guides`, aligning with our philosophy that: * Documentation focuses on core primitives * Guides show how to use Mastra with third‑party providers (including deployment) * Updated Deployment/Overview with a list of providers and added a Deployment/**Cloud Providers** index page so these guides stay easy to find and consistent with other deployment “methods” (e.g Deploy as part of a Monorepo) * Remove the LibSQL warning from the (now deleted) Deployment/Cloud Providers/Overview and add it directly to each serverless deployer page, so the warning appears where it matters most. * Rewrite the Deployment/Overview: * Remove the thin, repetitive table each option is now described more concisely in its own section, making it easier to scan. * Remove the Client reference, since it’s already documented and more logically associated with the server, and is not specific to deployment (e.g. some framework integrations won’t use Mastra Client). * Update internal links throughout to reflect the new structure and add the necessary redirects to `vercel.json` to preserve existing URLs. Notes: * Known issue: the link checker is currently failing because it does not understand `/v1/` links; this is a tooling limitation, not a broken‑link issue introduced by this PR. * Known limitation / future work: the current docs still don’t clearly explain the relationship between a Mastra server and full‑stack integrations. Each Cloud Provider guide also needs to be re‑tested and most likely rewritten for clarity and consistency; that work is out of scope for this PR and will be addressed in a follow‑up. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized deployment docs and Mastra Cloud into a clearer structure, updated sidebar/navigation, and added redirects to new paths. * Added a Cloud Providers landing page and seven provider guides; expanded monorepo and web‑framework deployment guidance with examples, warnings, and config notes. * Renamed "Building Mastra" to "Deploy a Mastra Server" and removed legacy MastraCloud callouts; updated numerous internal links and observability/dashboard references. * **Style** * Replaced "experimental" badges/labels with "beta" across the docs. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-12-16 20:26:45 +00:00
2026-01-20 17:22:17 +01:00
docs: move Mastra Cloud to top-level docs category (#11177) Changes: * Rename the "Experimental" label to "Beta" across CSS and components, to match our terminology and better communicate stability (with room to add "Alpha" later). * Promote **Mastra Cloud** to its own top‑level documentation category (rather than under Deployment), reflecting it as a discrete product and improving discoverability. * Move Cloud Provider deployment guides (e.g. Vercel, Netlify) into `/guides`, aligning with our philosophy that: * Documentation focuses on core primitives * Guides show how to use Mastra with third‑party providers (including deployment) * Updated Deployment/Overview with a list of providers and added a Deployment/**Cloud Providers** index page so these guides stay easy to find and consistent with other deployment “methods” (e.g Deploy as part of a Monorepo) * Remove the LibSQL warning from the (now deleted) Deployment/Cloud Providers/Overview and add it directly to each serverless deployer page, so the warning appears where it matters most. * Rewrite the Deployment/Overview: * Remove the thin, repetitive table each option is now described more concisely in its own section, making it easier to scan. * Remove the Client reference, since it’s already documented and more logically associated with the server, and is not specific to deployment (e.g. some framework integrations won’t use Mastra Client). * Update internal links throughout to reflect the new structure and add the necessary redirects to `vercel.json` to preserve existing URLs. Notes: * Known issue: the link checker is currently failing because it does not understand `/v1/` links; this is a tooling limitation, not a broken‑link issue introduced by this PR. * Known limitation / future work: the current docs still don’t clearly explain the relationship between a Mastra server and full‑stack integrations. Each Cloud Provider guide also needs to be re‑tested and most likely rewritten for clarity and consistency; that work is out of scope for this PR and will be addressed in a follow‑up. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized deployment docs and Mastra Cloud into a clearer structure, updated sidebar/navigation, and added redirects to new paths. * Added a Cloud Providers landing page and seven provider guides; expanded monorepo and web‑framework deployment guidance with examples, warnings, and config notes. * Renamed "Building Mastra" to "Deploy a Mastra Server" and removed legacy MastraCloud callouts; updated numerous internal links and observability/dashboard references. * **Style** * Replaced "experimental" badges/labels with "beta" across the docs. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-12-16 20:26:45 +00:00
2026-01-20 17:22:17 +01:00
docs: move Mastra Cloud to top-level docs category (#11177) Changes: * Rename the "Experimental" label to "Beta" across CSS and components, to match our terminology and better communicate stability (with room to add "Alpha" later). * Promote **Mastra Cloud** to its own top‑level documentation category (rather than under Deployment), reflecting it as a discrete product and improving discoverability. * Move Cloud Provider deployment guides (e.g. Vercel, Netlify) into `/guides`, aligning with our philosophy that: * Documentation focuses on core primitives * Guides show how to use Mastra with third‑party providers (including deployment) * Updated Deployment/Overview with a list of providers and added a Deployment/**Cloud Providers** index page so these guides stay easy to find and consistent with other deployment “methods” (e.g Deploy as part of a Monorepo) * Remove the LibSQL warning from the (now deleted) Deployment/Cloud Providers/Overview and add it directly to each serverless deployer page, so the warning appears where it matters most. * Rewrite the Deployment/Overview: * Remove the thin, repetitive table each option is now described more concisely in its own section, making it easier to scan. * Remove the Client reference, since it’s already documented and more logically associated with the server, and is not specific to deployment (e.g. some framework integrations won’t use Mastra Client). * Update internal links throughout to reflect the new structure and add the necessary redirects to `vercel.json` to preserve existing URLs. Notes: * Known issue: the link checker is currently failing because it does not understand `/v1/` links; this is a tooling limitation, not a broken‑link issue introduced by this PR. * Known limitation / future work: the current docs still don’t clearly explain the relationship between a Mastra server and full‑stack integrations. Each Cloud Provider guide also needs to be re‑tested and most likely rewritten for clarity and consistency; that work is out of scope for this PR and will be addressed in a follow‑up. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized deployment docs and Mastra Cloud into a clearer structure, updated sidebar/navigation, and added redirects to new paths. * Added a Cloud Providers landing page and seven provider guides; expanded monorepo and web‑framework deployment guidance with examples, warnings, and config notes. * Renamed "Building Mastra" to "Deploy a Mastra Server" and removed legacy MastraCloud callouts; updated numerous internal links and observability/dashboard references. * **Style** * Replaced "experimental" badges/labels with "beta" across the docs. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-12-16 20:26:45 +00:00
2026-01-20 17:22:17 +01:00
docs: move Mastra Cloud to top-level docs category (#11177) Changes: * Rename the "Experimental" label to "Beta" across CSS and components, to match our terminology and better communicate stability (with room to add "Alpha" later). * Promote **Mastra Cloud** to its own top‑level documentation category (rather than under Deployment), reflecting it as a discrete product and improving discoverability. * Move Cloud Provider deployment guides (e.g. Vercel, Netlify) into `/guides`, aligning with our philosophy that: * Documentation focuses on core primitives * Guides show how to use Mastra with third‑party providers (including deployment) * Updated Deployment/Overview with a list of providers and added a Deployment/**Cloud Providers** index page so these guides stay easy to find and consistent with other deployment “methods” (e.g Deploy as part of a Monorepo) * Remove the LibSQL warning from the (now deleted) Deployment/Cloud Providers/Overview and add it directly to each serverless deployer page, so the warning appears where it matters most. * Rewrite the Deployment/Overview: * Remove the thin, repetitive table each option is now described more concisely in its own section, making it easier to scan. * Remove the Client reference, since it’s already documented and more logically associated with the server, and is not specific to deployment (e.g. some framework integrations won’t use Mastra Client). * Update internal links throughout to reflect the new structure and add the necessary redirects to `vercel.json` to preserve existing URLs. Notes: * Known issue: the link checker is currently failing because it does not understand `/v1/` links; this is a tooling limitation, not a broken‑link issue introduced by this PR. * Known limitation / future work: the current docs still don’t clearly explain the relationship between a Mastra server and full‑stack integrations. Each Cloud Provider guide also needs to be re‑tested and most likely rewritten for clarity and consistency; that work is out of scope for this PR and will be addressed in a follow‑up. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized deployment docs and Mastra Cloud into a clearer structure, updated sidebar/navigation, and added redirects to new paths. * Added a Cloud Providers landing page and seven provider guides; expanded monorepo and web‑framework deployment guidance with examples, warnings, and config notes. * Renamed "Building Mastra" to "Deploy a Mastra Server" and removed legacy MastraCloud callouts; updated numerous internal links and observability/dashboard references. * **Style** * Replaced "experimental" badges/labels with "beta" across the docs. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-12-16 20:26:45 +00:00
2026-01-20 17:22:17 +01:00
docs: move Mastra Cloud to top-level docs category (#11177) Changes: * Rename the "Experimental" label to "Beta" across CSS and components, to match our terminology and better communicate stability (with room to add "Alpha" later). * Promote **Mastra Cloud** to its own top‑level documentation category (rather than under Deployment), reflecting it as a discrete product and improving discoverability. * Move Cloud Provider deployment guides (e.g. Vercel, Netlify) into `/guides`, aligning with our philosophy that: * Documentation focuses on core primitives * Guides show how to use Mastra with third‑party providers (including deployment) * Updated Deployment/Overview with a list of providers and added a Deployment/**Cloud Providers** index page so these guides stay easy to find and consistent with other deployment “methods” (e.g Deploy as part of a Monorepo) * Remove the LibSQL warning from the (now deleted) Deployment/Cloud Providers/Overview and add it directly to each serverless deployer page, so the warning appears where it matters most. * Rewrite the Deployment/Overview: * Remove the thin, repetitive table each option is now described more concisely in its own section, making it easier to scan. * Remove the Client reference, since it’s already documented and more logically associated with the server, and is not specific to deployment (e.g. some framework integrations won’t use Mastra Client). * Update internal links throughout to reflect the new structure and add the necessary redirects to `vercel.json` to preserve existing URLs. Notes: * Known issue: the link checker is currently failing because it does not understand `/v1/` links; this is a tooling limitation, not a broken‑link issue introduced by this PR. * Known limitation / future work: the current docs still don’t clearly explain the relationship between a Mastra server and full‑stack integrations. Each Cloud Provider guide also needs to be re‑tested and most likely rewritten for clarity and consistency; that work is out of scope for this PR and will be addressed in a follow‑up. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized deployment docs and Mastra Cloud into a clearer structure, updated sidebar/navigation, and added redirects to new paths. * Added a Cloud Providers landing page and seven provider guides; expanded monorepo and web‑framework deployment guidance with examples, warnings, and config notes. * Renamed "Building Mastra" to "Deploy a Mastra Server" and removed legacy MastraCloud callouts; updated numerous internal links and observability/dashboard references. * **Style** * Replaced "experimental" badges/labels with "beta" across the docs. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-12-16 20:26:45 +00:00
2026-01-20 17:22:17 +01:00
docs: move Mastra Cloud to top-level docs category (#11177) Changes: * Rename the "Experimental" label to "Beta" across CSS and components, to match our terminology and better communicate stability (with room to add "Alpha" later). * Promote **Mastra Cloud** to its own top‑level documentation category (rather than under Deployment), reflecting it as a discrete product and improving discoverability. * Move Cloud Provider deployment guides (e.g. Vercel, Netlify) into `/guides`, aligning with our philosophy that: * Documentation focuses on core primitives * Guides show how to use Mastra with third‑party providers (including deployment) * Updated Deployment/Overview with a list of providers and added a Deployment/**Cloud Providers** index page so these guides stay easy to find and consistent with other deployment “methods” (e.g Deploy as part of a Monorepo) * Remove the LibSQL warning from the (now deleted) Deployment/Cloud Providers/Overview and add it directly to each serverless deployer page, so the warning appears where it matters most. * Rewrite the Deployment/Overview: * Remove the thin, repetitive table each option is now described more concisely in its own section, making it easier to scan. * Remove the Client reference, since it’s already documented and more logically associated with the server, and is not specific to deployment (e.g. some framework integrations won’t use Mastra Client). * Update internal links throughout to reflect the new structure and add the necessary redirects to `vercel.json` to preserve existing URLs. Notes: * Known issue: the link checker is currently failing because it does not understand `/v1/` links; this is a tooling limitation, not a broken‑link issue introduced by this PR. * Known limitation / future work: the current docs still don’t clearly explain the relationship between a Mastra server and full‑stack integrations. Each Cloud Provider guide also needs to be re‑tested and most likely rewritten for clarity and consistency; that work is out of scope for this PR and will be addressed in a follow‑up. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized deployment docs and Mastra Cloud into a clearer structure, updated sidebar/navigation, and added redirects to new paths. * Added a Cloud Providers landing page and seven provider guides; expanded monorepo and web‑framework deployment guidance with examples, warnings, and config notes. * Renamed "Building Mastra" to "Deploy a Mastra Server" and removed legacy MastraCloud callouts; updated numerous internal links and observability/dashboard references. * **Style** * Replaced "experimental" badges/labels with "beta" across the docs. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-12-16 20:26:45 +00:00
2026-01-20 17:22:17 +01:00
docs: move Mastra Cloud to top-level docs category (#11177) Changes: * Rename the "Experimental" label to "Beta" across CSS and components, to match our terminology and better communicate stability (with room to add "Alpha" later). * Promote **Mastra Cloud** to its own top‑level documentation category (rather than under Deployment), reflecting it as a discrete product and improving discoverability. * Move Cloud Provider deployment guides (e.g. Vercel, Netlify) into `/guides`, aligning with our philosophy that: * Documentation focuses on core primitives * Guides show how to use Mastra with third‑party providers (including deployment) * Updated Deployment/Overview with a list of providers and added a Deployment/**Cloud Providers** index page so these guides stay easy to find and consistent with other deployment “methods” (e.g Deploy as part of a Monorepo) * Remove the LibSQL warning from the (now deleted) Deployment/Cloud Providers/Overview and add it directly to each serverless deployer page, so the warning appears where it matters most. * Rewrite the Deployment/Overview: * Remove the thin, repetitive table each option is now described more concisely in its own section, making it easier to scan. * Remove the Client reference, since it’s already documented and more logically associated with the server, and is not specific to deployment (e.g. some framework integrations won’t use Mastra Client). * Update internal links throughout to reflect the new structure and add the necessary redirects to `vercel.json` to preserve existing URLs. Notes: * Known issue: the link checker is currently failing because it does not understand `/v1/` links; this is a tooling limitation, not a broken‑link issue introduced by this PR. * Known limitation / future work: the current docs still don’t clearly explain the relationship between a Mastra server and full‑stack integrations. Each Cloud Provider guide also needs to be re‑tested and most likely rewritten for clarity and consistency; that work is out of scope for this PR and will be addressed in a follow‑up. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized deployment docs and Mastra Cloud into a clearer structure, updated sidebar/navigation, and added redirects to new paths. * Added a Cloud Providers landing page and seven provider guides; expanded monorepo and web‑framework deployment guidance with examples, warnings, and config notes. * Renamed "Building Mastra" to "Deploy a Mastra Server" and removed legacy MastraCloud callouts; updated numerous internal links and observability/dashboard references. * **Style** * Replaced "experimental" badges/labels with "beta" across the docs. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-12-16 20:26:45 +00:00
2026-01-20 17:22:17 +01:00
docs: move Mastra Cloud to top-level docs category (#11177) Changes: * Rename the "Experimental" label to "Beta" across CSS and components, to match our terminology and better communicate stability (with room to add "Alpha" later). * Promote **Mastra Cloud** to its own top‑level documentation category (rather than under Deployment), reflecting it as a discrete product and improving discoverability. * Move Cloud Provider deployment guides (e.g. Vercel, Netlify) into `/guides`, aligning with our philosophy that: * Documentation focuses on core primitives * Guides show how to use Mastra with third‑party providers (including deployment) * Updated Deployment/Overview with a list of providers and added a Deployment/**Cloud Providers** index page so these guides stay easy to find and consistent with other deployment “methods” (e.g Deploy as part of a Monorepo) * Remove the LibSQL warning from the (now deleted) Deployment/Cloud Providers/Overview and add it directly to each serverless deployer page, so the warning appears where it matters most. * Rewrite the Deployment/Overview: * Remove the thin, repetitive table each option is now described more concisely in its own section, making it easier to scan. * Remove the Client reference, since it’s already documented and more logically associated with the server, and is not specific to deployment (e.g. some framework integrations won’t use Mastra Client). * Update internal links throughout to reflect the new structure and add the necessary redirects to `vercel.json` to preserve existing URLs. Notes: * Known issue: the link checker is currently failing because it does not understand `/v1/` links; this is a tooling limitation, not a broken‑link issue introduced by this PR. * Known limitation / future work: the current docs still don’t clearly explain the relationship between a Mastra server and full‑stack integrations. Each Cloud Provider guide also needs to be re‑tested and most likely rewritten for clarity and consistency; that work is out of scope for this PR and will be addressed in a follow‑up. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized deployment docs and Mastra Cloud into a clearer structure, updated sidebar/navigation, and added redirects to new paths. * Added a Cloud Providers landing page and seven provider guides; expanded monorepo and web‑framework deployment guidance with examples, warnings, and config notes. * Renamed "Building Mastra" to "Deploy a Mastra Server" and removed legacy MastraCloud callouts; updated numerous internal links and observability/dashboard references. * **Style** * Replaced "experimental" badges/labels with "beta" across the docs. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-12-16 20:26:45 +00:00
2026-01-20 17:22:17 +01:00
docs: move Mastra Cloud to top-level docs category (#11177) Changes: * Rename the "Experimental" label to "Beta" across CSS and components, to match our terminology and better communicate stability (with room to add "Alpha" later). * Promote **Mastra Cloud** to its own top‑level documentation category (rather than under Deployment), reflecting it as a discrete product and improving discoverability. * Move Cloud Provider deployment guides (e.g. Vercel, Netlify) into `/guides`, aligning with our philosophy that: * Documentation focuses on core primitives * Guides show how to use Mastra with third‑party providers (including deployment) * Updated Deployment/Overview with a list of providers and added a Deployment/**Cloud Providers** index page so these guides stay easy to find and consistent with other deployment “methods” (e.g Deploy as part of a Monorepo) * Remove the LibSQL warning from the (now deleted) Deployment/Cloud Providers/Overview and add it directly to each serverless deployer page, so the warning appears where it matters most. * Rewrite the Deployment/Overview: * Remove the thin, repetitive table each option is now described more concisely in its own section, making it easier to scan. * Remove the Client reference, since it’s already documented and more logically associated with the server, and is not specific to deployment (e.g. some framework integrations won’t use Mastra Client). * Update internal links throughout to reflect the new structure and add the necessary redirects to `vercel.json` to preserve existing URLs. Notes: * Known issue: the link checker is currently failing because it does not understand `/v1/` links; this is a tooling limitation, not a broken‑link issue introduced by this PR. * Known limitation / future work: the current docs still don’t clearly explain the relationship between a Mastra server and full‑stack integrations. Each Cloud Provider guide also needs to be re‑tested and most likely rewritten for clarity and consistency; that work is out of scope for this PR and will be addressed in a follow‑up. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized deployment docs and Mastra Cloud into a clearer structure, updated sidebar/navigation, and added redirects to new paths. * Added a Cloud Providers landing page and seven provider guides; expanded monorepo and web‑framework deployment guidance with examples, warnings, and config notes. * Renamed "Building Mastra" to "Deploy a Mastra Server" and removed legacy MastraCloud callouts; updated numerous internal links and observability/dashboard references. * **Style** * Replaced "experimental" badges/labels with "beta" across the docs. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-12-16 20:26:45 +00:00
2026-01-20 17:22:17 +01:00
docs: move Mastra Cloud to top-level docs category (#11177) Changes: * Rename the "Experimental" label to "Beta" across CSS and components, to match our terminology and better communicate stability (with room to add "Alpha" later). * Promote **Mastra Cloud** to its own top‑level documentation category (rather than under Deployment), reflecting it as a discrete product and improving discoverability. * Move Cloud Provider deployment guides (e.g. Vercel, Netlify) into `/guides`, aligning with our philosophy that: * Documentation focuses on core primitives * Guides show how to use Mastra with third‑party providers (including deployment) * Updated Deployment/Overview with a list of providers and added a Deployment/**Cloud Providers** index page so these guides stay easy to find and consistent with other deployment “methods” (e.g Deploy as part of a Monorepo) * Remove the LibSQL warning from the (now deleted) Deployment/Cloud Providers/Overview and add it directly to each serverless deployer page, so the warning appears where it matters most. * Rewrite the Deployment/Overview: * Remove the thin, repetitive table each option is now described more concisely in its own section, making it easier to scan. * Remove the Client reference, since it’s already documented and more logically associated with the server, and is not specific to deployment (e.g. some framework integrations won’t use Mastra Client). * Update internal links throughout to reflect the new structure and add the necessary redirects to `vercel.json` to preserve existing URLs. Notes: * Known issue: the link checker is currently failing because it does not understand `/v1/` links; this is a tooling limitation, not a broken‑link issue introduced by this PR. * Known limitation / future work: the current docs still don’t clearly explain the relationship between a Mastra server and full‑stack integrations. Each Cloud Provider guide also needs to be re‑tested and most likely rewritten for clarity and consistency; that work is out of scope for this PR and will be addressed in a follow‑up. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized deployment docs and Mastra Cloud into a clearer structure, updated sidebar/navigation, and added redirects to new paths. * Added a Cloud Providers landing page and seven provider guides; expanded monorepo and web‑framework deployment guidance with examples, warnings, and config notes. * Renamed "Building Mastra" to "Deploy a Mastra Server" and removed legacy MastraCloud callouts; updated numerous internal links and observability/dashboard references. * **Style** * Replaced "experimental" badges/labels with "beta" across the docs. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-12-16 20:26:45 +00:00
2026-01-20 17:22:17 +01:00
docs: move Mastra Cloud to top-level docs category (#11177) Changes: * Rename the "Experimental" label to "Beta" across CSS and components, to match our terminology and better communicate stability (with room to add "Alpha" later). * Promote **Mastra Cloud** to its own top‑level documentation category (rather than under Deployment), reflecting it as a discrete product and improving discoverability. * Move Cloud Provider deployment guides (e.g. Vercel, Netlify) into `/guides`, aligning with our philosophy that: * Documentation focuses on core primitives * Guides show how to use Mastra with third‑party providers (including deployment) * Updated Deployment/Overview with a list of providers and added a Deployment/**Cloud Providers** index page so these guides stay easy to find and consistent with other deployment “methods” (e.g Deploy as part of a Monorepo) * Remove the LibSQL warning from the (now deleted) Deployment/Cloud Providers/Overview and add it directly to each serverless deployer page, so the warning appears where it matters most. * Rewrite the Deployment/Overview: * Remove the thin, repetitive table each option is now described more concisely in its own section, making it easier to scan. * Remove the Client reference, since it’s already documented and more logically associated with the server, and is not specific to deployment (e.g. some framework integrations won’t use Mastra Client). * Update internal links throughout to reflect the new structure and add the necessary redirects to `vercel.json` to preserve existing URLs. Notes: * Known issue: the link checker is currently failing because it does not understand `/v1/` links; this is a tooling limitation, not a broken‑link issue introduced by this PR. * Known limitation / future work: the current docs still don’t clearly explain the relationship between a Mastra server and full‑stack integrations. Each Cloud Provider guide also needs to be re‑tested and most likely rewritten for clarity and consistency; that work is out of scope for this PR and will be addressed in a follow‑up. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized deployment docs and Mastra Cloud into a clearer structure, updated sidebar/navigation, and added redirects to new paths. * Added a Cloud Providers landing page and seven provider guides; expanded monorepo and web‑framework deployment guidance with examples, warnings, and config notes. * Renamed "Building Mastra" to "Deploy a Mastra Server" and removed legacy MastraCloud callouts; updated numerous internal links and observability/dashboard references. * **Style** * Replaced "experimental" badges/labels with "beta" across the docs. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-12-16 20:26:45 +00:00
2026-01-20 17:22:17 +01:00
docs: move Mastra Cloud to top-level docs category (#11177) Changes: * Rename the "Experimental" label to "Beta" across CSS and components, to match our terminology and better communicate stability (with room to add "Alpha" later). * Promote **Mastra Cloud** to its own top‑level documentation category (rather than under Deployment), reflecting it as a discrete product and improving discoverability. * Move Cloud Provider deployment guides (e.g. Vercel, Netlify) into `/guides`, aligning with our philosophy that: * Documentation focuses on core primitives * Guides show how to use Mastra with third‑party providers (including deployment) * Updated Deployment/Overview with a list of providers and added a Deployment/**Cloud Providers** index page so these guides stay easy to find and consistent with other deployment “methods” (e.g Deploy as part of a Monorepo) * Remove the LibSQL warning from the (now deleted) Deployment/Cloud Providers/Overview and add it directly to each serverless deployer page, so the warning appears where it matters most. * Rewrite the Deployment/Overview: * Remove the thin, repetitive table each option is now described more concisely in its own section, making it easier to scan. * Remove the Client reference, since it’s already documented and more logically associated with the server, and is not specific to deployment (e.g. some framework integrations won’t use Mastra Client). * Update internal links throughout to reflect the new structure and add the necessary redirects to `vercel.json` to preserve existing URLs. Notes: * Known issue: the link checker is currently failing because it does not understand `/v1/` links; this is a tooling limitation, not a broken‑link issue introduced by this PR. * Known limitation / future work: the current docs still don’t clearly explain the relationship between a Mastra server and full‑stack integrations. Each Cloud Provider guide also needs to be re‑tested and most likely rewritten for clarity and consistency; that work is out of scope for this PR and will be addressed in a follow‑up. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized deployment docs and Mastra Cloud into a clearer structure, updated sidebar/navigation, and added redirects to new paths. * Added a Cloud Providers landing page and seven provider guides; expanded monorepo and web‑framework deployment guidance with examples, warnings, and config notes. * Renamed "Building Mastra" to "Deploy a Mastra Server" and removed legacy MastraCloud callouts; updated numerous internal links and observability/dashboard references. * **Style** * Replaced "experimental" badges/labels with "beta" across the docs. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-12-16 20:26:45 +00:00
2026-01-20 17:22:17 +01:00
docs: move Mastra Cloud to top-level docs category (#11177) Changes: * Rename the "Experimental" label to "Beta" across CSS and components, to match our terminology and better communicate stability (with room to add "Alpha" later). * Promote **Mastra Cloud** to its own top‑level documentation category (rather than under Deployment), reflecting it as a discrete product and improving discoverability. * Move Cloud Provider deployment guides (e.g. Vercel, Netlify) into `/guides`, aligning with our philosophy that: * Documentation focuses on core primitives * Guides show how to use Mastra with third‑party providers (including deployment) * Updated Deployment/Overview with a list of providers and added a Deployment/**Cloud Providers** index page so these guides stay easy to find and consistent with other deployment “methods” (e.g Deploy as part of a Monorepo) * Remove the LibSQL warning from the (now deleted) Deployment/Cloud Providers/Overview and add it directly to each serverless deployer page, so the warning appears where it matters most. * Rewrite the Deployment/Overview: * Remove the thin, repetitive table each option is now described more concisely in its own section, making it easier to scan. * Remove the Client reference, since it’s already documented and more logically associated with the server, and is not specific to deployment (e.g. some framework integrations won’t use Mastra Client). * Update internal links throughout to reflect the new structure and add the necessary redirects to `vercel.json` to preserve existing URLs. Notes: * Known issue: the link checker is currently failing because it does not understand `/v1/` links; this is a tooling limitation, not a broken‑link issue introduced by this PR. * Known limitation / future work: the current docs still don’t clearly explain the relationship between a Mastra server and full‑stack integrations. Each Cloud Provider guide also needs to be re‑tested and most likely rewritten for clarity and consistency; that work is out of scope for this PR and will be addressed in a follow‑up. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized deployment docs and Mastra Cloud into a clearer structure, updated sidebar/navigation, and added redirects to new paths. * Added a Cloud Providers landing page and seven provider guides; expanded monorepo and web‑framework deployment guidance with examples, warnings, and config notes. * Renamed "Building Mastra" to "Deploy a Mastra Server" and removed legacy MastraCloud callouts; updated numerous internal links and observability/dashboard references. * **Style** * Replaced "experimental" badges/labels with "beta" across the docs. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-12-16 20:26:45 +00:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-08-17 12:17:06 +02:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-08-17 12:17:06 +02:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
2026-01-20 17:22:17 +01:00
chore(docs): Update outdated content (#11826) ## Description Checked the current docs against the migration guide and made sure everything is up to date. ## Related Issue(s) <!-- Link to the issue(s) this PR addresses, using hashtag notation: Fixes #123 --> ## Type of Change - [ ] Bug fix (non-breaking change that fixes an issue) - [ ] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [X] Documentation update - [ ] Code refactoring - [ ] Performance improvement - [ ] Test update ## Checklist - [ ] I have made corresponding changes to the documentation (if applicable) - [ ] I have added tests that prove my fix is effective or that my feature works <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Examples now include explicit id fields for agents, storages, and vector stores; added docs redirects. * **Breaking Changes** * Removed workflow event pages for sendEvent/waitForEvent; use suspend/resume. * Example/API names updated: createRunAsync→createRun, runExecutionResult→runById. * Common signature/field changes in examples: handlers adopt (inputData, context); tripwireReason→tripwire.reason; generateTitle moved to top-level; CompositeVoice.realtime replaces realtimeProvider; setTelemetry docs removed. * **Documentation** * Extensive docs and example updates and deletions to reflect the above. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2026-01-14 00:55:13 +01:00
2026-01-20 17:22:17 +01:00
chore(docs): Update outdated content (#11826) ## Description Checked the current docs against the migration guide and made sure everything is up to date. ## Related Issue(s) <!-- Link to the issue(s) this PR addresses, using hashtag notation: Fixes #123 --> ## Type of Change - [ ] Bug fix (non-breaking change that fixes an issue) - [ ] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [X] Documentation update - [ ] Code refactoring - [ ] Performance improvement - [ ] Test update ## Checklist - [ ] I have made corresponding changes to the documentation (if applicable) - [ ] I have added tests that prove my fix is effective or that my feature works <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Examples now include explicit id fields for agents, storages, and vector stores; added docs redirects. * **Breaking Changes** * Removed workflow event pages for sendEvent/waitForEvent; use suspend/resume. * Example/API names updated: createRunAsync→createRun, runExecutionResult→runById. * Common signature/field changes in examples: handlers adopt (inputData, context); tripwireReason→tripwire.reason; generateTitle moved to top-level; CompositeVoice.realtime replaces realtimeProvider; setTelemetry docs removed. * **Documentation** * Extensive docs and example updates and deletions to reflect the above. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2026-01-14 00:55:13 +01:00
2026-01-20 17:22:17 +01:00
chore(docs): Update outdated content (#11826) ## Description Checked the current docs against the migration guide and made sure everything is up to date. ## Related Issue(s) <!-- Link to the issue(s) this PR addresses, using hashtag notation: Fixes #123 --> ## Type of Change - [ ] Bug fix (non-breaking change that fixes an issue) - [ ] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [X] Documentation update - [ ] Code refactoring - [ ] Performance improvement - [ ] Test update ## Checklist - [ ] I have made corresponding changes to the documentation (if applicable) - [ ] I have added tests that prove my fix is effective or that my feature works <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Examples now include explicit id fields for agents, storages, and vector stores; added docs redirects. * **Breaking Changes** * Removed workflow event pages for sendEvent/waitForEvent; use suspend/resume. * Example/API names updated: createRunAsync→createRun, runExecutionResult→runById. * Common signature/field changes in examples: handlers adopt (inputData, context); tripwireReason→tripwire.reason; generateTitle moved to top-level; CompositeVoice.realtime replaces realtimeProvider; setTelemetry docs removed. * **Documentation** * Extensive docs and example updates and deletions to reflect the above. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2026-01-14 00:55:13 +01:00
2026-01-20 17:22:17 +01:00
chore(docs): Update outdated content (#11826) ## Description Checked the current docs against the migration guide and made sure everything is up to date. ## Related Issue(s) <!-- Link to the issue(s) this PR addresses, using hashtag notation: Fixes #123 --> ## Type of Change - [ ] Bug fix (non-breaking change that fixes an issue) - [ ] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [X] Documentation update - [ ] Code refactoring - [ ] Performance improvement - [ ] Test update ## Checklist - [ ] I have made corresponding changes to the documentation (if applicable) - [ ] I have added tests that prove my fix is effective or that my feature works <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Examples now include explicit id fields for agents, storages, and vector stores; added docs redirects. * **Breaking Changes** * Removed workflow event pages for sendEvent/waitForEvent; use suspend/resume. * Example/API names updated: createRunAsync→createRun, runExecutionResult→runById. * Common signature/field changes in examples: handlers adopt (inputData, context); tripwireReason→tripwire.reason; generateTitle moved to top-level; CompositeVoice.realtime replaces realtimeProvider; setTelemetry docs removed. * **Documentation** * Extensive docs and example updates and deletions to reflect the above. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2026-01-14 00:55:13 +01:00
fix(core): remove deprecated threadId/resourceId from AgentExecutionOptions (#11897) Removes the deprecated `threadId` and `resourceId` options from `AgentExecutionOptions`, these have been deprecated for months. These were deprecated in favour of the `memory` option Before: ```ts await agent.stream('Hello', { threadId: 'thread-123', resourceId: 'user-456', }); ``` After: ```ts await agent.stream('Hello', { memory: { thread: 'thread-123', resource: 'user-456', }, }); ``` Also updates the migration guide, API reference docs, and tests to use the new format. The legacy methods (`generateLegacy`, `streamLegacy`) still support the old fields. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Breaking Changes** * Removed top-level threadId/resourceId options — use memory: { thread, resource } instead. * **Documentation** * Added migration guides and updated examples to show memory-based usage. * Removed deprecated Memory.query() docs and added redirect to Memory.recall(). * **Compatibility** * Legacy endpoints continue accepting threadId/resourceId for backward compatibility. * **Client SDKs** * Client and React SDKs now send memory objects; React auto-converts legacy fields. * **Tests** * Updated tests and integration suites to use the memory object shape. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Abhi Aiyer <abhiaiyer91@gmail.com> Co-authored-by: Lennart <lekoarts@gmail.com> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Co-authored-by: Ward Peeters <ward@coding-tech.com>
2026-01-15 14:10:08 -04:00
2026-01-20 17:22:17 +01:00
fix(core): remove deprecated threadId/resourceId from AgentExecutionOptions (#11897) Removes the deprecated `threadId` and `resourceId` options from `AgentExecutionOptions`, these have been deprecated for months. These were deprecated in favour of the `memory` option Before: ```ts await agent.stream('Hello', { threadId: 'thread-123', resourceId: 'user-456', }); ``` After: ```ts await agent.stream('Hello', { memory: { thread: 'thread-123', resource: 'user-456', }, }); ``` Also updates the migration guide, API reference docs, and tests to use the new format. The legacy methods (`generateLegacy`, `streamLegacy`) still support the old fields. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Breaking Changes** * Removed top-level threadId/resourceId options — use memory: { thread, resource } instead. * **Documentation** * Added migration guides and updated examples to show memory-based usage. * Removed deprecated Memory.query() docs and added redirect to Memory.recall(). * **Compatibility** * Legacy endpoints continue accepting threadId/resourceId for backward compatibility. * **Client SDKs** * Client and React SDKs now send memory objects; React auto-converts legacy fields. * **Tests** * Updated tests and integration suites to use the memory object shape. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Abhi Aiyer <abhiaiyer91@gmail.com> Co-authored-by: Lennart <lekoarts@gmail.com> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Co-authored-by: Ward Peeters <ward@coding-tech.com>
2026-01-15 14:10:08 -04:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-03-31 15:54:38 +02:00
2026-03-31 15:54:38 +02:00
2026-03-31 15:54:38 +02:00
2026-03-31 15:54:38 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
chore(docs): Fix harness redirects (#18595) ## Description <!-- Required: Provide a brief description of the changes in this PR. --> ## Related issue(s) <!-- Required: Link to the issue(s) this PR addresses, e.g. with: Fixes #123. PRs without linked issues may be closed. --> ## Type of change - [ ] Bug fix (non-breaking change that fixes an issue) - [ ] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update - [ ] Code refactoring - [ ] Performance improvement - [ ] Test update ## Checklist - [ ] I have linked the related issue(s) in the description above - [ ] I have made corresponding changes to the documentation (if applicable) - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have addressed all Coderabbit comments on this PR <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This change fixes some broken links in the docs by sending old Harness page URLs to their new home. It also adds a few more redirects so people who use the old pages still end up in the right place. ## Summary - Updated `docs/vercel.json` redirect rules for `/docs/harness/*` paths. - Moved the existing redirects into a new block later in the array. - Kept the redirects permanent and expanded coverage to include: - `/docs/harness/overview` - `/docs/harness/session` - `/docs/harness/threads-and-state` - `/docs/harness/modes` - `/docs/harness/subagents` - `/docs/harness/tool-approvals` - All of these now point to the corresponding `/docs/agent-controller/*` pages. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-06-29 10:27:44 +02:00
chore(docs): Fix harness redirects (#18595) ## Description <!-- Required: Provide a brief description of the changes in this PR. --> ## Related issue(s) <!-- Required: Link to the issue(s) this PR addresses, e.g. with: Fixes #123. PRs without linked issues may be closed. --> ## Type of change - [ ] Bug fix (non-breaking change that fixes an issue) - [ ] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update - [ ] Code refactoring - [ ] Performance improvement - [ ] Test update ## Checklist - [ ] I have linked the related issue(s) in the description above - [ ] I have made corresponding changes to the documentation (if applicable) - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have addressed all Coderabbit comments on this PR <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This change fixes some broken links in the docs by sending old Harness page URLs to their new home. It also adds a few more redirects so people who use the old pages still end up in the right place. ## Summary - Updated `docs/vercel.json` redirect rules for `/docs/harness/*` paths. - Moved the existing redirects into a new block later in the array. - Kept the redirects permanent and expanded coverage to include: - `/docs/harness/overview` - `/docs/harness/session` - `/docs/harness/threads-and-state` - `/docs/harness/modes` - `/docs/harness/subagents` - `/docs/harness/tool-approvals` - All of these now point to the corresponding `/docs/agent-controller/*` pages. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-06-29 10:27:44 +02:00
chore(docs): Fix harness redirects (#18595) ## Description <!-- Required: Provide a brief description of the changes in this PR. --> ## Related issue(s) <!-- Required: Link to the issue(s) this PR addresses, e.g. with: Fixes #123. PRs without linked issues may be closed. --> ## Type of change - [ ] Bug fix (non-breaking change that fixes an issue) - [ ] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update - [ ] Code refactoring - [ ] Performance improvement - [ ] Test update ## Checklist - [ ] I have linked the related issue(s) in the description above - [ ] I have made corresponding changes to the documentation (if applicable) - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have addressed all Coderabbit comments on this PR <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This change fixes some broken links in the docs by sending old Harness page URLs to their new home. It also adds a few more redirects so people who use the old pages still end up in the right place. ## Summary - Updated `docs/vercel.json` redirect rules for `/docs/harness/*` paths. - Moved the existing redirects into a new block later in the array. - Kept the redirects permanent and expanded coverage to include: - `/docs/harness/overview` - `/docs/harness/session` - `/docs/harness/threads-and-state` - `/docs/harness/modes` - `/docs/harness/subagents` - `/docs/harness/tool-approvals` - All of these now point to the corresponding `/docs/agent-controller/*` pages. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-06-29 10:27:44 +02:00
chore(docs): Fix harness redirects (#18595) ## Description <!-- Required: Provide a brief description of the changes in this PR. --> ## Related issue(s) <!-- Required: Link to the issue(s) this PR addresses, e.g. with: Fixes #123. PRs without linked issues may be closed. --> ## Type of change - [ ] Bug fix (non-breaking change that fixes an issue) - [ ] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update - [ ] Code refactoring - [ ] Performance improvement - [ ] Test update ## Checklist - [ ] I have linked the related issue(s) in the description above - [ ] I have made corresponding changes to the documentation (if applicable) - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have addressed all Coderabbit comments on this PR <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This change fixes some broken links in the docs by sending old Harness page URLs to their new home. It also adds a few more redirects so people who use the old pages still end up in the right place. ## Summary - Updated `docs/vercel.json` redirect rules for `/docs/harness/*` paths. - Moved the existing redirects into a new block later in the array. - Kept the redirects permanent and expanded coverage to include: - `/docs/harness/overview` - `/docs/harness/session` - `/docs/harness/threads-and-state` - `/docs/harness/modes` - `/docs/harness/subagents` - `/docs/harness/tool-approvals` - All of these now point to the corresponding `/docs/agent-controller/*` pages. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-06-29 10:27:44 +02:00
chore(docs): Fix harness redirects (#18595) ## Description <!-- Required: Provide a brief description of the changes in this PR. --> ## Related issue(s) <!-- Required: Link to the issue(s) this PR addresses, e.g. with: Fixes #123. PRs without linked issues may be closed. --> ## Type of change - [ ] Bug fix (non-breaking change that fixes an issue) - [ ] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update - [ ] Code refactoring - [ ] Performance improvement - [ ] Test update ## Checklist - [ ] I have linked the related issue(s) in the description above - [ ] I have made corresponding changes to the documentation (if applicable) - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have addressed all Coderabbit comments on this PR <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This change fixes some broken links in the docs by sending old Harness page URLs to their new home. It also adds a few more redirects so people who use the old pages still end up in the right place. ## Summary - Updated `docs/vercel.json` redirect rules for `/docs/harness/*` paths. - Moved the existing redirects into a new block later in the array. - Kept the redirects permanent and expanded coverage to include: - `/docs/harness/overview` - `/docs/harness/session` - `/docs/harness/threads-and-state` - `/docs/harness/modes` - `/docs/harness/subagents` - `/docs/harness/tool-approvals` - All of these now point to the corresponding `/docs/agent-controller/*` pages. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-06-29 10:27:44 +02:00
chore(docs): Fix harness redirects (#18595) ## Description <!-- Required: Provide a brief description of the changes in this PR. --> ## Related issue(s) <!-- Required: Link to the issue(s) this PR addresses, e.g. with: Fixes #123. PRs without linked issues may be closed. --> ## Type of change - [ ] Bug fix (non-breaking change that fixes an issue) - [ ] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update - [ ] Code refactoring - [ ] Performance improvement - [ ] Test update ## Checklist - [ ] I have linked the related issue(s) in the description above - [ ] I have made corresponding changes to the documentation (if applicable) - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have addressed all Coderabbit comments on this PR <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This change fixes some broken links in the docs by sending old Harness page URLs to their new home. It also adds a few more redirects so people who use the old pages still end up in the right place. ## Summary - Updated `docs/vercel.json` redirect rules for `/docs/harness/*` paths. - Moved the existing redirects into a new block later in the array. - Kept the redirects permanent and expanded coverage to include: - `/docs/harness/overview` - `/docs/harness/session` - `/docs/harness/threads-and-state` - `/docs/harness/modes` - `/docs/harness/subagents` - `/docs/harness/tool-approvals` - All of these now point to the corresponding `/docs/agent-controller/*` pages. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-06-29 10:27:44 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-12 14:17:06 +01:00
docs: add Observe sidebar section (#20728) ## Summary - add a top-level Observe section for tracing, metrics, evals, and datasets - keep Production focused on server and deployment docs - merge observability configuration and storage guidance into the overview - place Tracing directly after Overview and nest integrations under Tracing - redirect the removed configuration and storage routes to the merged overview ## Testing - `pnpm --dir docs build` - `pnpm --dir docs validate` - `pnpm --dir docs lint:prose` (Remark passes; Vale reports a pre-existing issue in `docs/src/content/en/docs/server/mastra-client.mdx`) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 The documentation now has one clear place for observability setup and storage guidance. Older page and `llms.txt` links redirect to the new overview. ## Changes - Added a top-level **Observe** section to the documentation sidebar. - Grouped tracing, metrics, evaluations, and datasets under **Observe**. - Moved **Deployment** earlier in the **Production** section. - Merged observability configuration and storage guidance into `observability/overview`. - Kept **Tracing** after **Overview** and nested integrations under it. - Updated links to use the merged overview and page anchors. - Added permanent redirects for the removed configuration and storage routes, including `llms.txt` routes. - Removed the standalone observability configuration and storage pages. ## Validation - Documentation build passed. - Remark passed. - Vale reported a pre-existing issue in `docs/src/content/en/docs/server/mastra-client.mdx`. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Lennart <lekoarts@gmail.com>
2026-08-05 09:24:31 +01:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
docs: remove redundant tutorials (#21238) This removes tutorials that duplicate maintained documentation while preserving the useful MCP publishing guidance on the canonical MCP page. | Tutorial | Action | Rationale | | --- | --- | --- | | Slack Assistant | Remove | The Slack channel documentation covers the same setup and provides more complete guidance for authentication, events, interactivity, and deployment. | | WhatsApp Chat Bot | Remove | The tutorial uses an older manual webhook implementation. The WhatsApp channel adapter is the supported path and includes the relevant setup in one maintained page. | | Web Search | Remove | The built-in `webSearchTool` documentation provides the current provider-agnostic approach and supports the maintained provider integrations. | | Publishing an MCP Server | Move into the MCP overview | Publishing is too narrow for a standalone tutorial, but the stdio entry point, package configuration, and client setup remain useful beside the canonical MCP server documentation. | | Chef Michel | Remove | This is primarily a themed version of the standard agent quickstart and does not teach a distinct Mastra concept. | | Stock Agent | Remove | This duplicates the custom tool quickstart. It also reads the previous trading day's `4. close` value but returns it as `currentPrice` and presents it as the current stock price, which can give readers stale market data under an inaccurate label. | <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This PR removes old tutorials that duplicate maintained documentation. It keeps selected tutorials, moves MCP publishing content to the main MCP page, and redirects old links to current pages. ## Changes - Removed the Slack Assistant, WhatsApp Chat Bot, Web Search, Chef Michel, Stock Agent, and Publishing an MCP Server tutorials. - Retained the Research Assistant, Code Review Bot, and Docs Manager tutorials. - Added MCP stdio server publishing instructions to the MCP overview page. - Pinned the MCP subprocess example to version `1.0.0`. - Updated MCP example links. - Added permanent redirects for removed guide routes and `.llms.txt` routes. - Removed the WhatsApp guide from the feature-versioning map. - Added redirect regression coverage. - No tests were added. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-11 12:47:41 +01:00
docs: remove redundant tutorials (#21238) This removes tutorials that duplicate maintained documentation while preserving the useful MCP publishing guidance on the canonical MCP page. | Tutorial | Action | Rationale | | --- | --- | --- | | Slack Assistant | Remove | The Slack channel documentation covers the same setup and provides more complete guidance for authentication, events, interactivity, and deployment. | | WhatsApp Chat Bot | Remove | The tutorial uses an older manual webhook implementation. The WhatsApp channel adapter is the supported path and includes the relevant setup in one maintained page. | | Web Search | Remove | The built-in `webSearchTool` documentation provides the current provider-agnostic approach and supports the maintained provider integrations. | | Publishing an MCP Server | Move into the MCP overview | Publishing is too narrow for a standalone tutorial, but the stdio entry point, package configuration, and client setup remain useful beside the canonical MCP server documentation. | | Chef Michel | Remove | This is primarily a themed version of the standard agent quickstart and does not teach a distinct Mastra concept. | | Stock Agent | Remove | This duplicates the custom tool quickstart. It also reads the previous trading day's `4. close` value but returns it as `currentPrice` and presents it as the current stock price, which can give readers stale market data under an inaccurate label. | <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This PR removes old tutorials that duplicate maintained documentation. It keeps selected tutorials, moves MCP publishing content to the main MCP page, and redirects old links to current pages. ## Changes - Removed the Slack Assistant, WhatsApp Chat Bot, Web Search, Chef Michel, Stock Agent, and Publishing an MCP Server tutorials. - Retained the Research Assistant, Code Review Bot, and Docs Manager tutorials. - Added MCP stdio server publishing instructions to the MCP overview page. - Pinned the MCP subprocess example to version `1.0.0`. - Updated MCP example links. - Added permanent redirects for removed guide routes and `.llms.txt` routes. - Removed the WhatsApp guide from the feature-versioning map. - Added redirect regression coverage. - No tests were added. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-11 12:47:41 +01:00
docs: remove redundant tutorials (#21238) This removes tutorials that duplicate maintained documentation while preserving the useful MCP publishing guidance on the canonical MCP page. | Tutorial | Action | Rationale | | --- | --- | --- | | Slack Assistant | Remove | The Slack channel documentation covers the same setup and provides more complete guidance for authentication, events, interactivity, and deployment. | | WhatsApp Chat Bot | Remove | The tutorial uses an older manual webhook implementation. The WhatsApp channel adapter is the supported path and includes the relevant setup in one maintained page. | | Web Search | Remove | The built-in `webSearchTool` documentation provides the current provider-agnostic approach and supports the maintained provider integrations. | | Publishing an MCP Server | Move into the MCP overview | Publishing is too narrow for a standalone tutorial, but the stdio entry point, package configuration, and client setup remain useful beside the canonical MCP server documentation. | | Chef Michel | Remove | This is primarily a themed version of the standard agent quickstart and does not teach a distinct Mastra concept. | | Stock Agent | Remove | This duplicates the custom tool quickstart. It also reads the previous trading day's `4. close` value but returns it as `currentPrice` and presents it as the current stock price, which can give readers stale market data under an inaccurate label. | <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This PR removes old tutorials that duplicate maintained documentation. It keeps selected tutorials, moves MCP publishing content to the main MCP page, and redirects old links to current pages. ## Changes - Removed the Slack Assistant, WhatsApp Chat Bot, Web Search, Chef Michel, Stock Agent, and Publishing an MCP Server tutorials. - Retained the Research Assistant, Code Review Bot, and Docs Manager tutorials. - Added MCP stdio server publishing instructions to the MCP overview page. - Pinned the MCP subprocess example to version `1.0.0`. - Updated MCP example links. - Added permanent redirects for removed guide routes and `.llms.txt` routes. - Removed the WhatsApp guide from the feature-versioning map. - Added redirect regression coverage. - No tests were added. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-11 12:47:41 +01:00
2026-08-17 12:17:06 +02:00
docs: remove redundant tutorials (#21238) This removes tutorials that duplicate maintained documentation while preserving the useful MCP publishing guidance on the canonical MCP page. | Tutorial | Action | Rationale | | --- | --- | --- | | Slack Assistant | Remove | The Slack channel documentation covers the same setup and provides more complete guidance for authentication, events, interactivity, and deployment. | | WhatsApp Chat Bot | Remove | The tutorial uses an older manual webhook implementation. The WhatsApp channel adapter is the supported path and includes the relevant setup in one maintained page. | | Web Search | Remove | The built-in `webSearchTool` documentation provides the current provider-agnostic approach and supports the maintained provider integrations. | | Publishing an MCP Server | Move into the MCP overview | Publishing is too narrow for a standalone tutorial, but the stdio entry point, package configuration, and client setup remain useful beside the canonical MCP server documentation. | | Chef Michel | Remove | This is primarily a themed version of the standard agent quickstart and does not teach a distinct Mastra concept. | | Stock Agent | Remove | This duplicates the custom tool quickstart. It also reads the previous trading day's `4. close` value but returns it as `currentPrice` and presents it as the current stock price, which can give readers stale market data under an inaccurate label. | <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This PR removes old tutorials that duplicate maintained documentation. It keeps selected tutorials, moves MCP publishing content to the main MCP page, and redirects old links to current pages. ## Changes - Removed the Slack Assistant, WhatsApp Chat Bot, Web Search, Chef Michel, Stock Agent, and Publishing an MCP Server tutorials. - Retained the Research Assistant, Code Review Bot, and Docs Manager tutorials. - Added MCP stdio server publishing instructions to the MCP overview page. - Pinned the MCP subprocess example to version `1.0.0`. - Updated MCP example links. - Added permanent redirects for removed guide routes and `.llms.txt` routes. - Removed the WhatsApp guide from the feature-versioning map. - Added redirect regression coverage. - No tests were added. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-11 12:47:41 +01:00
2026-08-17 12:17:06 +02:00
docs: remove redundant tutorials (#21238) This removes tutorials that duplicate maintained documentation while preserving the useful MCP publishing guidance on the canonical MCP page. | Tutorial | Action | Rationale | | --- | --- | --- | | Slack Assistant | Remove | The Slack channel documentation covers the same setup and provides more complete guidance for authentication, events, interactivity, and deployment. | | WhatsApp Chat Bot | Remove | The tutorial uses an older manual webhook implementation. The WhatsApp channel adapter is the supported path and includes the relevant setup in one maintained page. | | Web Search | Remove | The built-in `webSearchTool` documentation provides the current provider-agnostic approach and supports the maintained provider integrations. | | Publishing an MCP Server | Move into the MCP overview | Publishing is too narrow for a standalone tutorial, but the stdio entry point, package configuration, and client setup remain useful beside the canonical MCP server documentation. | | Chef Michel | Remove | This is primarily a themed version of the standard agent quickstart and does not teach a distinct Mastra concept. | | Stock Agent | Remove | This duplicates the custom tool quickstart. It also reads the previous trading day's `4. close` value but returns it as `currentPrice` and presents it as the current stock price, which can give readers stale market data under an inaccurate label. | <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This PR removes old tutorials that duplicate maintained documentation. It keeps selected tutorials, moves MCP publishing content to the main MCP page, and redirects old links to current pages. ## Changes - Removed the Slack Assistant, WhatsApp Chat Bot, Web Search, Chef Michel, Stock Agent, and Publishing an MCP Server tutorials. - Retained the Research Assistant, Code Review Bot, and Docs Manager tutorials. - Added MCP stdio server publishing instructions to the MCP overview page. - Pinned the MCP subprocess example to version `1.0.0`. - Updated MCP example links. - Added permanent redirects for removed guide routes and `.llms.txt` routes. - Removed the WhatsApp guide from the feature-versioning map. - Added redirect regression coverage. - No tests were added. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-11 12:47:41 +01:00
2026-08-17 12:17:06 +02:00
docs: remove redundant tutorials (#21238) This removes tutorials that duplicate maintained documentation while preserving the useful MCP publishing guidance on the canonical MCP page. | Tutorial | Action | Rationale | | --- | --- | --- | | Slack Assistant | Remove | The Slack channel documentation covers the same setup and provides more complete guidance for authentication, events, interactivity, and deployment. | | WhatsApp Chat Bot | Remove | The tutorial uses an older manual webhook implementation. The WhatsApp channel adapter is the supported path and includes the relevant setup in one maintained page. | | Web Search | Remove | The built-in `webSearchTool` documentation provides the current provider-agnostic approach and supports the maintained provider integrations. | | Publishing an MCP Server | Move into the MCP overview | Publishing is too narrow for a standalone tutorial, but the stdio entry point, package configuration, and client setup remain useful beside the canonical MCP server documentation. | | Chef Michel | Remove | This is primarily a themed version of the standard agent quickstart and does not teach a distinct Mastra concept. | | Stock Agent | Remove | This duplicates the custom tool quickstart. It also reads the previous trading day's `4. close` value but returns it as `currentPrice` and presents it as the current stock price, which can give readers stale market data under an inaccurate label. | <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This PR removes old tutorials that duplicate maintained documentation. It keeps selected tutorials, moves MCP publishing content to the main MCP page, and redirects old links to current pages. ## Changes - Removed the Slack Assistant, WhatsApp Chat Bot, Web Search, Chef Michel, Stock Agent, and Publishing an MCP Server tutorials. - Retained the Research Assistant, Code Review Bot, and Docs Manager tutorials. - Added MCP stdio server publishing instructions to the MCP overview page. - Pinned the MCP subprocess example to version `1.0.0`. - Updated MCP example links. - Added permanent redirects for removed guide routes and `.llms.txt` routes. - Removed the WhatsApp guide from the feature-versioning map. - Added redirect regression coverage. - No tests were added. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-11 12:47:41 +01:00
2026-08-12 14:17:06 +01:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
docs(signals): reorganize Signals docs into task-based guides (#28022) ## Why The Signals documentation was one 555-line page under **Harness** that tried to cover four different jobs at once: explaining what signals are, showing how to send them, documenting state signals and notifications, and explaining providers and multi-process deployment. Readers had to scan a single long page to find the one task they cared about, and reference-level details were mixed in with the guide. This reorganizes Signals as a first-class section under **Extend** and gives each reader task its own page. The conceptual spine is **signals are input; thread streams are output**. `Agent` stays the primary API; the AgentController `Session` surface is shown as a higher-level mapping, not the default. ## What changed - Added seven Signals guides under `/docs/signals`: - **Overview**: when to use signals, the thread/run/signal/thread-stream model, Quickstart, and choosing an API surface - **Thread streams**: subscribe-before-send, stored history, chunks, approvals, filtering, reconnect, and replay boundaries - **Sending signals**: message and typed-signal input, delivery timing, payloads, cancellation, and the Agent-versus-Session mapping - **State signals**: snapshots and deltas, processor-computed state, deduplication, persistence, and built-in uses - **Notifications**: durable inbox records, deduplication/coalescing, delivery policies, dispatch, retries, and the inbox tool - **Signal providers**: subscriptions, polling, webhooks, lifecycle hooks, processors/tools, and production concerns - **Running across processes**: leases, remote routing, delivery guarantees, crashes, serverless, and shutdown - Moved the section from **Harness** to **Extend**, immediately after **Channels**. - Added `reference/signals/notifications` for `NotificationRecord`, priorities, statuses, delivery decisions, policy evaluation, dispatch configuration, and delivered-signal metadata. - Added `reference/signals/thread-events` for the public `subscribeThreadEvents()` surface and `AgentThreadEvent`. The internal thread-runtime event union is deliberately not documented as public API. - Added the `thread-history` chunk to the `ChunkType` reference, including `messages`, `hasMore`, and the `withInitialHistory` condition. - Moved the Mastra Code cross-agent setup to `docs/src/mastra-code/configuration.mdx` and left a pointer from the Signals overview. - Updated the docs and reference sidebars, inbound links, and page-level redirects from the old Harness routes. - Folded the separate “Signals in the agent loop” draft page into the pages that own its material (Sending signals, Thread streams, Running across processes, Processors, and the tracing overview). ## Test plan - [x] `pnpm --filter mastra-docs test -- --reporter=dot` — 170 tests passed - [x] `pnpm --filter mastra-docs validate:frontmatter` — 679 files passed - [x] `pnpm --filter mastra-docs validate:reference-sidebar` — sort order passed - [x] `pnpm --filter mastra-docs validate:sidebar-docs` — all docs linked - [x] `pnpm --filter mastra-docs format:mdx:check` — 717 MDX files checked - [x] `pnpm --filter mastra-docs lint:remark` — passed - [x] `pnpm --filter mastra-docs exec oxfmt-mdx --check src/mastra-code/configuration.mdx` — passed - [x] `pnpm --filter mastra-docs build` — production build succeeded - [x] `git diff --check` — clean Docs-only change. No runtime, package, dependency, or changeset changes. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> <!-- coderabbit-ai-generated:v1 --> ## ELI5 This PR moves the Signals documentation into a set of task-based guides and updates links from the old pages. It also adds references for notifications and thread events, so readers can find details about how signals and thread updates work. ## Changes - Adds seven guides under **Extend** for the Signals model, thread streams, sending signals, state signals, notifications, providers, and multi-process setup. - Adds reference pages for notifications and thread events, and documents the `thread-history` stream chunk. - Updates the sidebars, links, and permanent redirects for the new documentation paths. - Moves Mastra Code cross-agent setup guidance to its configuration page. - Updates processor documentation with a reactive signal example and documents the `computeStateSignal` processor hook. ## Validation The PR author reports that the documentation tests, validators, formatting checks, build, and `git diff --check` passed. The reported test run had 170 tests. These results were not independently verified. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: mastracode <284800079+mastra-platform[bot]@users.noreply.github.com>
2026-10-22 16:23:52 +02:00
2026-08-17 12:17:06 +02:00
docs(signals): reorganize Signals docs into task-based guides (#28022) ## Why The Signals documentation was one 555-line page under **Harness** that tried to cover four different jobs at once: explaining what signals are, showing how to send them, documenting state signals and notifications, and explaining providers and multi-process deployment. Readers had to scan a single long page to find the one task they cared about, and reference-level details were mixed in with the guide. This reorganizes Signals as a first-class section under **Extend** and gives each reader task its own page. The conceptual spine is **signals are input; thread streams are output**. `Agent` stays the primary API; the AgentController `Session` surface is shown as a higher-level mapping, not the default. ## What changed - Added seven Signals guides under `/docs/signals`: - **Overview**: when to use signals, the thread/run/signal/thread-stream model, Quickstart, and choosing an API surface - **Thread streams**: subscribe-before-send, stored history, chunks, approvals, filtering, reconnect, and replay boundaries - **Sending signals**: message and typed-signal input, delivery timing, payloads, cancellation, and the Agent-versus-Session mapping - **State signals**: snapshots and deltas, processor-computed state, deduplication, persistence, and built-in uses - **Notifications**: durable inbox records, deduplication/coalescing, delivery policies, dispatch, retries, and the inbox tool - **Signal providers**: subscriptions, polling, webhooks, lifecycle hooks, processors/tools, and production concerns - **Running across processes**: leases, remote routing, delivery guarantees, crashes, serverless, and shutdown - Moved the section from **Harness** to **Extend**, immediately after **Channels**. - Added `reference/signals/notifications` for `NotificationRecord`, priorities, statuses, delivery decisions, policy evaluation, dispatch configuration, and delivered-signal metadata. - Added `reference/signals/thread-events` for the public `subscribeThreadEvents()` surface and `AgentThreadEvent`. The internal thread-runtime event union is deliberately not documented as public API. - Added the `thread-history` chunk to the `ChunkType` reference, including `messages`, `hasMore`, and the `withInitialHistory` condition. - Moved the Mastra Code cross-agent setup to `docs/src/mastra-code/configuration.mdx` and left a pointer from the Signals overview. - Updated the docs and reference sidebars, inbound links, and page-level redirects from the old Harness routes. - Folded the separate “Signals in the agent loop” draft page into the pages that own its material (Sending signals, Thread streams, Running across processes, Processors, and the tracing overview). ## Test plan - [x] `pnpm --filter mastra-docs test -- --reporter=dot` — 170 tests passed - [x] `pnpm --filter mastra-docs validate:frontmatter` — 679 files passed - [x] `pnpm --filter mastra-docs validate:reference-sidebar` — sort order passed - [x] `pnpm --filter mastra-docs validate:sidebar-docs` — all docs linked - [x] `pnpm --filter mastra-docs format:mdx:check` — 717 MDX files checked - [x] `pnpm --filter mastra-docs lint:remark` — passed - [x] `pnpm --filter mastra-docs exec oxfmt-mdx --check src/mastra-code/configuration.mdx` — passed - [x] `pnpm --filter mastra-docs build` — production build succeeded - [x] `git diff --check` — clean Docs-only change. No runtime, package, dependency, or changeset changes. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> <!-- coderabbit-ai-generated:v1 --> ## ELI5 This PR moves the Signals documentation into a set of task-based guides and updates links from the old pages. It also adds references for notifications and thread events, so readers can find details about how signals and thread updates work. ## Changes - Adds seven guides under **Extend** for the Signals model, thread streams, sending signals, state signals, notifications, providers, and multi-process setup. - Adds reference pages for notifications and thread events, and documents the `thread-history` stream chunk. - Updates the sidebars, links, and permanent redirects for the new documentation paths. - Moves Mastra Code cross-agent setup guidance to its configuration page. - Updates processor documentation with a reactive signal example and documents the `computeStateSignal` processor hook. ## Validation The PR author reports that the documentation tests, validators, formatting checks, build, and `git diff --check` passed. The reported test run had 170 tests. These results were not independently verified. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: mastracode <284800079+mastra-platform[bot]@users.noreply.github.com>
2026-10-22 16:23:52 +02:00
2026-08-17 12:17:06 +02:00
docs: revert documentation changes from #23077 (#24031) ## Description Reverts the documentation portion of #23077 (the `@mastra/mcp` code and changeset are untouched). - Deletes `docs/src/content/en/docs/connections/connect-mcp-client.mdx` (the "Connect your MCP client to Mastra (draft)" page, which described an unimplemented `mastra mcp` launcher). - Restores `docs/src/content/en/docs/sidebars.js` so the Connections sidebar is a flat `MCP` doc entry again instead of the `Tools & MCP` category that #23077 introduced. The file is byte-identical to its pre-#23077 state. - Restores `docs/src/content/en/reference/tools/mcp-server.mdx` to its pre-#23077 state (removes the "Operate a remote Mastra server" section, which the removed page linked to). Byte-identical to pre-#23077. - Adds a permanent redirect `/docs/connections/connect-mcp-client` → `/docs/connections/mcp` in `vercel.redirects.json` (the page was already live on mastra.ai) and regenerates `vercel.json`, which also produces the `/llms.txt` companion redirect. Verification (from `docs/`): `pnpm format:check`, `pnpm validate`, redirect generator / move-doc / delete-doc script tests (88 passed), `git diff --check`, and `pnpm build`. A repo-wide grep for `connect-mcp-client`, `operate-a-remote-mastra-server`, and "Connect your MCP client" only matches the new redirect entries. ## Related issue(s) Reverts docs from #23077. Requested in Slack (#growth-docs). ## Type of change - [x] Documentation update ## Checklist - [x] I have linked the related issue(s) in the description above - [x] I have made corresponding changes to the documentation (if applicable) - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have addressed all Coderabbit comments on this PR Link to Devin session: https://app.devin.ai/sessions/abf500fe19fe4706b9b274dc6ade0cd2 Open in Devin Desktop: https://app.devin.ai/desktop/session/abf500fe19fe4706b9b274dc6ade0cd2?variant=devin <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This PR removes an unfinished MCP client documentation page and restores the previous MCP documentation. Old links now redirect to the current MCP page. ## Changes - Deleted the draft `connect-mcp-client.mdx` page. - Restored the Connections sidebar structure. - Removed the remote Mastra server section from the MCP server reference. - Added permanent redirects for: - `/docs/connections/connect-mcp-client` - `/docs/connections/connect-mcp-client/llms.txt` - Regenerated `vercel.json`. - Left `@mastra/mcp` code and its changeset unchanged. ## Verification Formatting, validation, redirect tests, diff checks, and the documentation build reportedly passed. <!-- 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>
2026-09-15 19:06:17 +01:00
docs(signals): reorganize Signals docs into task-based guides (#28022) ## Why The Signals documentation was one 555-line page under **Harness** that tried to cover four different jobs at once: explaining what signals are, showing how to send them, documenting state signals and notifications, and explaining providers and multi-process deployment. Readers had to scan a single long page to find the one task they cared about, and reference-level details were mixed in with the guide. This reorganizes Signals as a first-class section under **Extend** and gives each reader task its own page. The conceptual spine is **signals are input; thread streams are output**. `Agent` stays the primary API; the AgentController `Session` surface is shown as a higher-level mapping, not the default. ## What changed - Added seven Signals guides under `/docs/signals`: - **Overview**: when to use signals, the thread/run/signal/thread-stream model, Quickstart, and choosing an API surface - **Thread streams**: subscribe-before-send, stored history, chunks, approvals, filtering, reconnect, and replay boundaries - **Sending signals**: message and typed-signal input, delivery timing, payloads, cancellation, and the Agent-versus-Session mapping - **State signals**: snapshots and deltas, processor-computed state, deduplication, persistence, and built-in uses - **Notifications**: durable inbox records, deduplication/coalescing, delivery policies, dispatch, retries, and the inbox tool - **Signal providers**: subscriptions, polling, webhooks, lifecycle hooks, processors/tools, and production concerns - **Running across processes**: leases, remote routing, delivery guarantees, crashes, serverless, and shutdown - Moved the section from **Harness** to **Extend**, immediately after **Channels**. - Added `reference/signals/notifications` for `NotificationRecord`, priorities, statuses, delivery decisions, policy evaluation, dispatch configuration, and delivered-signal metadata. - Added `reference/signals/thread-events` for the public `subscribeThreadEvents()` surface and `AgentThreadEvent`. The internal thread-runtime event union is deliberately not documented as public API. - Added the `thread-history` chunk to the `ChunkType` reference, including `messages`, `hasMore`, and the `withInitialHistory` condition. - Moved the Mastra Code cross-agent setup to `docs/src/mastra-code/configuration.mdx` and left a pointer from the Signals overview. - Updated the docs and reference sidebars, inbound links, and page-level redirects from the old Harness routes. - Folded the separate “Signals in the agent loop” draft page into the pages that own its material (Sending signals, Thread streams, Running across processes, Processors, and the tracing overview). ## Test plan - [x] `pnpm --filter mastra-docs test -- --reporter=dot` — 170 tests passed - [x] `pnpm --filter mastra-docs validate:frontmatter` — 679 files passed - [x] `pnpm --filter mastra-docs validate:reference-sidebar` — sort order passed - [x] `pnpm --filter mastra-docs validate:sidebar-docs` — all docs linked - [x] `pnpm --filter mastra-docs format:mdx:check` — 717 MDX files checked - [x] `pnpm --filter mastra-docs lint:remark` — passed - [x] `pnpm --filter mastra-docs exec oxfmt-mdx --check src/mastra-code/configuration.mdx` — passed - [x] `pnpm --filter mastra-docs build` — production build succeeded - [x] `git diff --check` — clean Docs-only change. No runtime, package, dependency, or changeset changes. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> <!-- coderabbit-ai-generated:v1 --> ## ELI5 This PR moves the Signals documentation into a set of task-based guides and updates links from the old pages. It also adds references for notifications and thread events, so readers can find details about how signals and thread updates work. ## Changes - Adds seven guides under **Extend** for the Signals model, thread streams, sending signals, state signals, notifications, providers, and multi-process setup. - Adds reference pages for notifications and thread events, and documents the `thread-history` stream chunk. - Updates the sidebars, links, and permanent redirects for the new documentation paths. - Moves Mastra Code cross-agent setup guidance to its configuration page. - Updates processor documentation with a reactive signal example and documents the `computeStateSignal` processor hook. ## Validation The PR author reports that the documentation tests, validators, formatting checks, build, and `git diff --check` passed. The reported test run had 170 tests. These results were not independently verified. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: mastracode <284800079+mastra-platform[bot]@users.noreply.github.com>
2026-10-22 16:23:52 +02:00
revert(docs): remove end-user connections docs leaked into main (#28184) ## Summary The `@mastra/connect` end-user connections documentation was supposed to ship only on the docs PR [#27334](https://github.com/mastra-ai/mastra/pull/27334), but PRs #26923 and #26928 brought the following end-user connections docs content into main as part of the code merges: - `docs/src/content/en/docs/mastra-platform/connect/end-user-connections.mdx` (new file, from #26923) - `docs/src/content/en/reference/connect/user-connect-routes.mdx` (new file, from #26923) - Sidebar entries for both pages - `resourceId` option added to `credential.mdx` (from #26923) - `resourceId` and `connectPrompt` options added to `tools.mdx` (from #26923 and #26928) This PR removes all of that so #27334 owns the complete end-user connections documentation set. The code APIs remain shipped on main unchanged — only the docs are reverted. The docs PR already carries complete versions of every file touched here and will re-introduce them atomically when it merges. ## Verification - `docs/connect-project-provider-policy` branch (PR #27334) still contains `end-user-connections.mdx`, `user-connect-routes.mdx`, the sidebar entries, and the fuller `resourceId` / `connectPrompt` documentation on `tools.mdx` and `credential.mdx`. - No references to `end-user-connections`, `user-connect-routes`, or `userConnectRoutes` remain in `docs/src/content/en` after this revert. - Diff is 2 insertions / 271 deletions across 6 files. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> <!-- coderabbit-ai-generated:v1 --> ## ELI5 This PR removes documentation about end-user connections and redirects the old page URLs to related Connect pages. It also removes related option details from the reference docs; the PR description says the code APIs do not change. ## Summary - Deleted the end-user connections guide and the `userConnectRoutes()` reference page. - Removed both pages from their sidebars. - Removed `resourceId` from the documented `credential()` options. - Removed `resourceId` and `connectPrompt` from the documented `tools()` options. - Added redirects from the deleted pages and their `/llms.txt` routes to related Connect pages. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: mastracode <284800079+mastra-platform[bot]@users.noreply.github.com>
2026-10-22 14:42:27 -04:00
revert(docs): remove end-user connections docs leaked into main (#28184) ## Summary The `@mastra/connect` end-user connections documentation was supposed to ship only on the docs PR [#27334](https://github.com/mastra-ai/mastra/pull/27334), but PRs #26923 and #26928 brought the following end-user connections docs content into main as part of the code merges: - `docs/src/content/en/docs/mastra-platform/connect/end-user-connections.mdx` (new file, from #26923) - `docs/src/content/en/reference/connect/user-connect-routes.mdx` (new file, from #26923) - Sidebar entries for both pages - `resourceId` option added to `credential.mdx` (from #26923) - `resourceId` and `connectPrompt` options added to `tools.mdx` (from #26923 and #26928) This PR removes all of that so #27334 owns the complete end-user connections documentation set. The code APIs remain shipped on main unchanged — only the docs are reverted. The docs PR already carries complete versions of every file touched here and will re-introduce them atomically when it merges. ## Verification - `docs/connect-project-provider-policy` branch (PR #27334) still contains `end-user-connections.mdx`, `user-connect-routes.mdx`, the sidebar entries, and the fuller `resourceId` / `connectPrompt` documentation on `tools.mdx` and `credential.mdx`. - No references to `end-user-connections`, `user-connect-routes`, or `userConnectRoutes` remain in `docs/src/content/en` after this revert. - Diff is 2 insertions / 271 deletions across 6 files. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> <!-- coderabbit-ai-generated:v1 --> ## ELI5 This PR removes documentation about end-user connections and redirects the old page URLs to related Connect pages. It also removes related option details from the reference docs; the PR description says the code APIs do not change. ## Summary - Deleted the end-user connections guide and the `userConnectRoutes()` reference page. - Removed both pages from their sidebars. - Removed `resourceId` from the documented `credential()` options. - Removed `resourceId` and `connectPrompt` from the documented `tools()` options. - Added redirects from the deleted pages and their `/llms.txt` routes to related Connect pages. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: mastracode <284800079+mastra-platform[bot]@users.noreply.github.com>
2026-10-22 14:42:27 -04:00
2026-08-17 12:17:06 +02:00
docs: consolidate Editor documentation (#20653) ## Summary - consolidate the Editor docs into one task-focused overview page - move prompt block, tool configuration, and versioning details into focused Reference pages - explain database and code storage with concrete configurations and generated JSON examples - update navigation, inbound links, and redirects for the removed Prompt and Tools pages - correct Editor API, tool provider, versioning, and request-context details against the implementation ## Validation - `pnpm validate` - `pnpm format:mdx:check` - `pnpm lint:remark` - targeted Vale checks for changed Editor pages - `pnpm build` - `git diff --check` <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This PR makes the Editor documentation easier to use. It puts common guidance on one overview page and moves detailed prompt, tool, and versioning information into focused reference pages. ## Changes - Replaced the Editor overview with a task-focused guide covering: - Studio workflows - Prompt blocks - Tools and MCP clients - Permissions - Database and repository storage - Version selection - Programmatic access - Added Editor reference pages for: - Prompt blocks - Tool configuration - Versioning - Expanded tool provider documentation for Composio and Arcade. - Documented Editor storage configuration, including the `editor` option in `MastraCompositeStore`. - Updated API, versioning, request-context, storage, and tool provider details to match the implementation. - Removed the separate Prompt and Tools pages. - Updated sidebars, inbound links, playground links, and redirects for the removed pages. - Added examples for `codePath`, `MastraCompositeStore`, Composio, Arcade, REST draft creation, and agent namespaces. ## Validation - `pnpm validate` - MDX formatting and Remark lint checks - Targeted Vale checks - `pnpm build` - `git diff --check` <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-04 14:38:27 +01:00
2026-08-17 12:17:06 +02:00
docs: consolidate Editor documentation (#20653) ## Summary - consolidate the Editor docs into one task-focused overview page - move prompt block, tool configuration, and versioning details into focused Reference pages - explain database and code storage with concrete configurations and generated JSON examples - update navigation, inbound links, and redirects for the removed Prompt and Tools pages - correct Editor API, tool provider, versioning, and request-context details against the implementation ## Validation - `pnpm validate` - `pnpm format:mdx:check` - `pnpm lint:remark` - targeted Vale checks for changed Editor pages - `pnpm build` - `git diff --check` <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This PR makes the Editor documentation easier to use. It puts common guidance on one overview page and moves detailed prompt, tool, and versioning information into focused reference pages. ## Changes - Replaced the Editor overview with a task-focused guide covering: - Studio workflows - Prompt blocks - Tools and MCP clients - Permissions - Database and repository storage - Version selection - Programmatic access - Added Editor reference pages for: - Prompt blocks - Tool configuration - Versioning - Expanded tool provider documentation for Composio and Arcade. - Documented Editor storage configuration, including the `editor` option in `MastraCompositeStore`. - Updated API, versioning, request-context, storage, and tool provider details to match the implementation. - Removed the separate Prompt and Tools pages. - Updated sidebars, inbound links, playground links, and redirects for the removed pages. - Added examples for `codePath`, `MastraCompositeStore`, Composio, Arcade, REST draft creation, and agent namespaces. ## Validation - `pnpm validate` - MDX formatting and Remark lint checks - Targeted Vale checks - `pnpm build` - `git diff --check` <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-04 14:38:27 +01:00
2026-08-17 12:17:06 +02:00
docs: consolidate Editor documentation (#20653) ## Summary - consolidate the Editor docs into one task-focused overview page - move prompt block, tool configuration, and versioning details into focused Reference pages - explain database and code storage with concrete configurations and generated JSON examples - update navigation, inbound links, and redirects for the removed Prompt and Tools pages - correct Editor API, tool provider, versioning, and request-context details against the implementation ## Validation - `pnpm validate` - `pnpm format:mdx:check` - `pnpm lint:remark` - targeted Vale checks for changed Editor pages - `pnpm build` - `git diff --check` <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This PR makes the Editor documentation easier to use. It puts common guidance on one overview page and moves detailed prompt, tool, and versioning information into focused reference pages. ## Changes - Replaced the Editor overview with a task-focused guide covering: - Studio workflows - Prompt blocks - Tools and MCP clients - Permissions - Database and repository storage - Version selection - Programmatic access - Added Editor reference pages for: - Prompt blocks - Tool configuration - Versioning - Expanded tool provider documentation for Composio and Arcade. - Documented Editor storage configuration, including the `editor` option in `MastraCompositeStore`. - Updated API, versioning, request-context, storage, and tool provider details to match the implementation. - Removed the separate Prompt and Tools pages. - Updated sidebars, inbound links, playground links, and redirects for the removed pages. - Added examples for `codePath`, `MastraCompositeStore`, Composio, Arcade, REST draft creation, and agent namespaces. ## Validation - `pnpm validate` - MDX formatting and Remark lint checks - Targeted Vale checks - `pnpm build` - `git diff --check` <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-04 14:38:27 +01:00
2026-08-17 12:17:06 +02:00
2026-08-12 14:17:06 +01:00
2026-08-12 14:17:06 +01:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
feat!: rename heartbeats to schedules and unify with workflow schedules (#18874) Renames the heartbeats feature to schedules before we promote it, and merges agent + workflow scheduling into one API. "Heartbeat" reads as a liveness/health check to most programmers, but the feature is cron-based agent scheduling — so now there's a single `mastra.schedules` surface (create/get/list/update/pause/resume/run/delete) that handles both agent and workflow targets, discriminated by `agentId` vs `workflowId`. ```ts // before await mastra.heartbeats.create({ agentId: 'chef', cron: '0 9 * * *', prompt: 'Morning check-in' }); // after — same API also covers workflow schedules await mastra.schedules.create({ agentId: 'chef', cron: '0 9 * * *', prompt: 'Morning check-in' }); await mastra.schedules.create({ workflowId: 'digest', cron: '0 8 * * 1' }); ``` Server-side, `/api/heartbeats` is merged into `/api/schedules` (10 routes). Client-js gains `createSchedule`/`updateSchedule`/`deleteSchedule`/`runSchedule`, and the old heartbeat methods are deprecated but still work by delegating to the schedules API. Existing stored rows keep working: a read-shim in all 8 store implementations normalizes legacy `target.type: 'heartbeat'` rows to `'agent'` at deserialization. New agent schedule ids use the `agent_` prefix (old `hb_` ids still resolve when passed in full). Docs moved from `agents/heartbeats` to `agents/schedules` with a redirect. Verified with the core/server/client-js/store test suites (typecheck clean), plus an HTTP smoke test through the hono adapter covering full CRUD, pause/resume, manual run with trigger recording, legacy-row read-shim, and `/api/heartbeats` returning 404. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This PR renames “heartbeats” to “schedules” and uses one unified feature for both agent cron scheduling and workflow scheduling. It also keeps old saved heartbeat data working by automatically treating it as agent schedules, while moving the HTTP/SDK APIs and docs to the new `/api/schedules` + `mastra.schedules` system. ## Summary - Renamed the heartbeats feature to **schedules** and introduced a unified `mastra.schedules` API for both **agent** and **workflow** scheduling. - Added `mastra.schedules` operations: **create, get, list, update, pause, resume, run, delete**, distinguishing targets by **`agentId` vs `workflowId`**. - Consolidated server routes: **removed `/api/heartbeats`** and added **`/api/schedules`**; legacy heartbeat endpoints now return **404**. - Updated `@mastra/client-js` with new methods: **`createSchedule`, `updateSchedule`, `deleteSchedule`, `runSchedule`** and a schedule-shaped response model; kept old heartbeat client methods as **deprecated wrappers** delegating to the schedules API. - Implemented backward compatibility in storage: on read, all store implementations normalize legacy persisted rows with `target.type: 'heartbeat'` into `target.type: 'agent'`, and legacy **`hb_`** IDs still resolve when provided fully. - Introduced new schedule ID semantics: **agent schedules use `agent_` prefix** (workflow schedules use their new `schedule_` prefix). - Updated runtime orchestration to use schedule workers/topics (including scheduler + agent-schedule startup behavior) and added the “worker startup race” fix by memoizing the in-flight scheduler worker startup promise (with a regression test). - Tightened schedule create validation: `agentId`/`workflowId` now require `.min(1)` and create schemas are `.strict()` to prevent ambiguous payload routing (clear 400s). - Improved hookless schedule handling: schedule hook context loading is only attempted when hooks exist; lookup failures are now debug-logged instead of silently swallowed. - Migrated documentation and examples from **heartbeats → schedules**, including new pages, sidebar updates, and Vercel redirects. - Updated/extended tests across core, server, client-js, and storage (including an HTTP smoke test for CRUD, pause/resume, manual run, legacy-row reads, and `/api/heartbeats` → 404). - Bumped peer dependency ranges for affected packages to align with the updated `@mastra/core`. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Mastra Code (anthropic/claude-fable-5) <noreply@mastra.ai>
2026-07-06 14:15:40 +02:00
2026-08-17 12:17:06 +02:00
docs(signals): reorganize Signals docs into task-based guides (#28022) ## Why The Signals documentation was one 555-line page under **Harness** that tried to cover four different jobs at once: explaining what signals are, showing how to send them, documenting state signals and notifications, and explaining providers and multi-process deployment. Readers had to scan a single long page to find the one task they cared about, and reference-level details were mixed in with the guide. This reorganizes Signals as a first-class section under **Extend** and gives each reader task its own page. The conceptual spine is **signals are input; thread streams are output**. `Agent` stays the primary API; the AgentController `Session` surface is shown as a higher-level mapping, not the default. ## What changed - Added seven Signals guides under `/docs/signals`: - **Overview**: when to use signals, the thread/run/signal/thread-stream model, Quickstart, and choosing an API surface - **Thread streams**: subscribe-before-send, stored history, chunks, approvals, filtering, reconnect, and replay boundaries - **Sending signals**: message and typed-signal input, delivery timing, payloads, cancellation, and the Agent-versus-Session mapping - **State signals**: snapshots and deltas, processor-computed state, deduplication, persistence, and built-in uses - **Notifications**: durable inbox records, deduplication/coalescing, delivery policies, dispatch, retries, and the inbox tool - **Signal providers**: subscriptions, polling, webhooks, lifecycle hooks, processors/tools, and production concerns - **Running across processes**: leases, remote routing, delivery guarantees, crashes, serverless, and shutdown - Moved the section from **Harness** to **Extend**, immediately after **Channels**. - Added `reference/signals/notifications` for `NotificationRecord`, priorities, statuses, delivery decisions, policy evaluation, dispatch configuration, and delivered-signal metadata. - Added `reference/signals/thread-events` for the public `subscribeThreadEvents()` surface and `AgentThreadEvent`. The internal thread-runtime event union is deliberately not documented as public API. - Added the `thread-history` chunk to the `ChunkType` reference, including `messages`, `hasMore`, and the `withInitialHistory` condition. - Moved the Mastra Code cross-agent setup to `docs/src/mastra-code/configuration.mdx` and left a pointer from the Signals overview. - Updated the docs and reference sidebars, inbound links, and page-level redirects from the old Harness routes. - Folded the separate “Signals in the agent loop” draft page into the pages that own its material (Sending signals, Thread streams, Running across processes, Processors, and the tracing overview). ## Test plan - [x] `pnpm --filter mastra-docs test -- --reporter=dot` — 170 tests passed - [x] `pnpm --filter mastra-docs validate:frontmatter` — 679 files passed - [x] `pnpm --filter mastra-docs validate:reference-sidebar` — sort order passed - [x] `pnpm --filter mastra-docs validate:sidebar-docs` — all docs linked - [x] `pnpm --filter mastra-docs format:mdx:check` — 717 MDX files checked - [x] `pnpm --filter mastra-docs lint:remark` — passed - [x] `pnpm --filter mastra-docs exec oxfmt-mdx --check src/mastra-code/configuration.mdx` — passed - [x] `pnpm --filter mastra-docs build` — production build succeeded - [x] `git diff --check` — clean Docs-only change. No runtime, package, dependency, or changeset changes. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> <!-- coderabbit-ai-generated:v1 --> ## ELI5 This PR moves the Signals documentation into a set of task-based guides and updates links from the old pages. It also adds references for notifications and thread events, so readers can find details about how signals and thread updates work. ## Changes - Adds seven guides under **Extend** for the Signals model, thread streams, sending signals, state signals, notifications, providers, and multi-process setup. - Adds reference pages for notifications and thread events, and documents the `thread-history` stream chunk. - Updates the sidebars, links, and permanent redirects for the new documentation paths. - Moves Mastra Code cross-agent setup guidance to its configuration page. - Updates processor documentation with a reactive signal example and documents the `computeStateSignal` processor hook. ## Validation The PR author reports that the documentation tests, validators, formatting checks, build, and `git diff --check` passed. The reported test run had 170 tests. These results were not independently verified. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: mastracode <284800079+mastra-platform[bot]@users.noreply.github.com>
2026-10-22 16:23:52 +02:00
docs(signals): reorganize Signals docs into task-based guides (#28022) ## Why The Signals documentation was one 555-line page under **Harness** that tried to cover four different jobs at once: explaining what signals are, showing how to send them, documenting state signals and notifications, and explaining providers and multi-process deployment. Readers had to scan a single long page to find the one task they cared about, and reference-level details were mixed in with the guide. This reorganizes Signals as a first-class section under **Extend** and gives each reader task its own page. The conceptual spine is **signals are input; thread streams are output**. `Agent` stays the primary API; the AgentController `Session` surface is shown as a higher-level mapping, not the default. ## What changed - Added seven Signals guides under `/docs/signals`: - **Overview**: when to use signals, the thread/run/signal/thread-stream model, Quickstart, and choosing an API surface - **Thread streams**: subscribe-before-send, stored history, chunks, approvals, filtering, reconnect, and replay boundaries - **Sending signals**: message and typed-signal input, delivery timing, payloads, cancellation, and the Agent-versus-Session mapping - **State signals**: snapshots and deltas, processor-computed state, deduplication, persistence, and built-in uses - **Notifications**: durable inbox records, deduplication/coalescing, delivery policies, dispatch, retries, and the inbox tool - **Signal providers**: subscriptions, polling, webhooks, lifecycle hooks, processors/tools, and production concerns - **Running across processes**: leases, remote routing, delivery guarantees, crashes, serverless, and shutdown - Moved the section from **Harness** to **Extend**, immediately after **Channels**. - Added `reference/signals/notifications` for `NotificationRecord`, priorities, statuses, delivery decisions, policy evaluation, dispatch configuration, and delivered-signal metadata. - Added `reference/signals/thread-events` for the public `subscribeThreadEvents()` surface and `AgentThreadEvent`. The internal thread-runtime event union is deliberately not documented as public API. - Added the `thread-history` chunk to the `ChunkType` reference, including `messages`, `hasMore`, and the `withInitialHistory` condition. - Moved the Mastra Code cross-agent setup to `docs/src/mastra-code/configuration.mdx` and left a pointer from the Signals overview. - Updated the docs and reference sidebars, inbound links, and page-level redirects from the old Harness routes. - Folded the separate “Signals in the agent loop” draft page into the pages that own its material (Sending signals, Thread streams, Running across processes, Processors, and the tracing overview). ## Test plan - [x] `pnpm --filter mastra-docs test -- --reporter=dot` — 170 tests passed - [x] `pnpm --filter mastra-docs validate:frontmatter` — 679 files passed - [x] `pnpm --filter mastra-docs validate:reference-sidebar` — sort order passed - [x] `pnpm --filter mastra-docs validate:sidebar-docs` — all docs linked - [x] `pnpm --filter mastra-docs format:mdx:check` — 717 MDX files checked - [x] `pnpm --filter mastra-docs lint:remark` — passed - [x] `pnpm --filter mastra-docs exec oxfmt-mdx --check src/mastra-code/configuration.mdx` — passed - [x] `pnpm --filter mastra-docs build` — production build succeeded - [x] `git diff --check` — clean Docs-only change. No runtime, package, dependency, or changeset changes. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> <!-- coderabbit-ai-generated:v1 --> ## ELI5 This PR moves the Signals documentation into a set of task-based guides and updates links from the old pages. It also adds references for notifications and thread events, so readers can find details about how signals and thread updates work. ## Changes - Adds seven guides under **Extend** for the Signals model, thread streams, sending signals, state signals, notifications, providers, and multi-process setup. - Adds reference pages for notifications and thread events, and documents the `thread-history` stream chunk. - Updates the sidebars, links, and permanent redirects for the new documentation paths. - Moves Mastra Code cross-agent setup guidance to its configuration page. - Updates processor documentation with a reactive signal example and documents the `computeStateSignal` processor hook. ## Validation The PR author reports that the documentation tests, validators, formatting checks, build, and `git diff --check` passed. The reported test run had 170 tests. These results were not independently verified. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: mastracode <284800079+mastra-platform[bot]@users.noreply.github.com>
2026-10-22 16:23:52 +02:00
2026-08-12 14:17:06 +01:00
2026-08-12 14:17:06 +01:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-12 14:17:06 +01:00
2026-08-12 14:17:06 +01:00
docs: move datasets out of evals (#20689) ## Summary - move dataset and experiment docs from `/docs/evals/datasets/*` to `/docs/datasets/*` - place Datasets last in the Production sidebar group and update docs and Studio links - add direct redirects for old dataset routes and regenerate `vercel.json` without dataset redirect chains ## Validation - `pnpm build` - scoped Remark and Vale lint for changed docs - `pnpm --filter ./packages/playground lint` (passes with existing warnings) - dataset redirect-chain check across all six dataset-related entries in generated `vercel.json` Full `pnpm lint:prose` also reports four existing Vale errors in untouched docs pages. A strict global wildcard expansion finds pre-existing chains through broad version redirects such as `/docs/v1/:path* -> /docs/:path*`; this PR does not add any dataset redirect chains. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 The PR moves dataset documentation to a clearer location. It updates links and redirects so old pages still work. ## Changes - Moved dataset documentation from `/docs/evals/datasets/*` to `/docs/datasets/*`. - Added Datasets as a top-level Production sidebar section. - Updated documentation and Studio links to use the new paths. - Updated Playground dataset and experiment links. - Added direct redirects for legacy dataset routes and `/llms.txt` routes. - Regenerated `vercel.json` without redirect chains. ## Validation - Documentation build passed. - Scoped Remark and Vale linting passed. - Playground linting passed. - Redirect-chain checks passed. - Full prose linting reports four existing Vale errors in unchanged pages. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-04 16:26:32 +01:00
docs: add Observe sidebar section (#20728) ## Summary - add a top-level Observe section for tracing, metrics, evals, and datasets - keep Production focused on server and deployment docs - merge observability configuration and storage guidance into the overview - place Tracing directly after Overview and nest integrations under Tracing - redirect the removed configuration and storage routes to the merged overview ## Testing - `pnpm --dir docs build` - `pnpm --dir docs validate` - `pnpm --dir docs lint:prose` (Remark passes; Vale reports a pre-existing issue in `docs/src/content/en/docs/server/mastra-client.mdx`) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 The documentation now has one clear place for observability setup and storage guidance. Older page and `llms.txt` links redirect to the new overview. ## Changes - Added a top-level **Observe** section to the documentation sidebar. - Grouped tracing, metrics, evaluations, and datasets under **Observe**. - Moved **Deployment** earlier in the **Production** section. - Merged observability configuration and storage guidance into `observability/overview`. - Kept **Tracing** after **Overview** and nested integrations under it. - Updated links to use the merged overview and page anchors. - Added permanent redirects for the removed configuration and storage routes, including `llms.txt` routes. - Removed the standalone observability configuration and storage pages. ## Validation - Documentation build passed. - Remark passed. - Vale reported a pre-existing issue in `docs/src/content/en/docs/server/mastra-client.mdx`. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Lennart <lekoarts@gmail.com>
2026-08-05 09:24:31 +01:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
docs: remove redundant tutorials (#21238) This removes tutorials that duplicate maintained documentation while preserving the useful MCP publishing guidance on the canonical MCP page. | Tutorial | Action | Rationale | | --- | --- | --- | | Slack Assistant | Remove | The Slack channel documentation covers the same setup and provides more complete guidance for authentication, events, interactivity, and deployment. | | WhatsApp Chat Bot | Remove | The tutorial uses an older manual webhook implementation. The WhatsApp channel adapter is the supported path and includes the relevant setup in one maintained page. | | Web Search | Remove | The built-in `webSearchTool` documentation provides the current provider-agnostic approach and supports the maintained provider integrations. | | Publishing an MCP Server | Move into the MCP overview | Publishing is too narrow for a standalone tutorial, but the stdio entry point, package configuration, and client setup remain useful beside the canonical MCP server documentation. | | Chef Michel | Remove | This is primarily a themed version of the standard agent quickstart and does not teach a distinct Mastra concept. | | Stock Agent | Remove | This duplicates the custom tool quickstart. It also reads the previous trading day's `4. close` value but returns it as `currentPrice` and presents it as the current stock price, which can give readers stale market data under an inaccurate label. | <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This PR removes old tutorials that duplicate maintained documentation. It keeps selected tutorials, moves MCP publishing content to the main MCP page, and redirects old links to current pages. ## Changes - Removed the Slack Assistant, WhatsApp Chat Bot, Web Search, Chef Michel, Stock Agent, and Publishing an MCP Server tutorials. - Retained the Research Assistant, Code Review Bot, and Docs Manager tutorials. - Added MCP stdio server publishing instructions to the MCP overview page. - Pinned the MCP subprocess example to version `1.0.0`. - Updated MCP example links. - Added permanent redirects for removed guide routes and `.llms.txt` routes. - Removed the WhatsApp guide from the feature-versioning map. - Added redirect regression coverage. - No tests were added. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-11 12:47:41 +01:00
docs: remove redundant tutorials (#21238) This removes tutorials that duplicate maintained documentation while preserving the useful MCP publishing guidance on the canonical MCP page. | Tutorial | Action | Rationale | | --- | --- | --- | | Slack Assistant | Remove | The Slack channel documentation covers the same setup and provides more complete guidance for authentication, events, interactivity, and deployment. | | WhatsApp Chat Bot | Remove | The tutorial uses an older manual webhook implementation. The WhatsApp channel adapter is the supported path and includes the relevant setup in one maintained page. | | Web Search | Remove | The built-in `webSearchTool` documentation provides the current provider-agnostic approach and supports the maintained provider integrations. | | Publishing an MCP Server | Move into the MCP overview | Publishing is too narrow for a standalone tutorial, but the stdio entry point, package configuration, and client setup remain useful beside the canonical MCP server documentation. | | Chef Michel | Remove | This is primarily a themed version of the standard agent quickstart and does not teach a distinct Mastra concept. | | Stock Agent | Remove | This duplicates the custom tool quickstart. It also reads the previous trading day's `4. close` value but returns it as `currentPrice` and presents it as the current stock price, which can give readers stale market data under an inaccurate label. | <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This PR removes old tutorials that duplicate maintained documentation. It keeps selected tutorials, moves MCP publishing content to the main MCP page, and redirects old links to current pages. ## Changes - Removed the Slack Assistant, WhatsApp Chat Bot, Web Search, Chef Michel, Stock Agent, and Publishing an MCP Server tutorials. - Retained the Research Assistant, Code Review Bot, and Docs Manager tutorials. - Added MCP stdio server publishing instructions to the MCP overview page. - Pinned the MCP subprocess example to version `1.0.0`. - Updated MCP example links. - Added permanent redirects for removed guide routes and `.llms.txt` routes. - Removed the WhatsApp guide from the feature-versioning map. - Added redirect regression coverage. - No tests were added. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-11 12:47:41 +01:00
docs: remove redundant tutorials (#21238) This removes tutorials that duplicate maintained documentation while preserving the useful MCP publishing guidance on the canonical MCP page. | Tutorial | Action | Rationale | | --- | --- | --- | | Slack Assistant | Remove | The Slack channel documentation covers the same setup and provides more complete guidance for authentication, events, interactivity, and deployment. | | WhatsApp Chat Bot | Remove | The tutorial uses an older manual webhook implementation. The WhatsApp channel adapter is the supported path and includes the relevant setup in one maintained page. | | Web Search | Remove | The built-in `webSearchTool` documentation provides the current provider-agnostic approach and supports the maintained provider integrations. | | Publishing an MCP Server | Move into the MCP overview | Publishing is too narrow for a standalone tutorial, but the stdio entry point, package configuration, and client setup remain useful beside the canonical MCP server documentation. | | Chef Michel | Remove | This is primarily a themed version of the standard agent quickstart and does not teach a distinct Mastra concept. | | Stock Agent | Remove | This duplicates the custom tool quickstart. It also reads the previous trading day's `4. close` value but returns it as `currentPrice` and presents it as the current stock price, which can give readers stale market data under an inaccurate label. | <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This PR removes old tutorials that duplicate maintained documentation. It keeps selected tutorials, moves MCP publishing content to the main MCP page, and redirects old links to current pages. ## Changes - Removed the Slack Assistant, WhatsApp Chat Bot, Web Search, Chef Michel, Stock Agent, and Publishing an MCP Server tutorials. - Retained the Research Assistant, Code Review Bot, and Docs Manager tutorials. - Added MCP stdio server publishing instructions to the MCP overview page. - Pinned the MCP subprocess example to version `1.0.0`. - Updated MCP example links. - Added permanent redirects for removed guide routes and `.llms.txt` routes. - Removed the WhatsApp guide from the feature-versioning map. - Added redirect regression coverage. - No tests were added. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-11 12:47:41 +01:00
2026-08-17 12:17:06 +02:00
docs: remove redundant tutorials (#21238) This removes tutorials that duplicate maintained documentation while preserving the useful MCP publishing guidance on the canonical MCP page. | Tutorial | Action | Rationale | | --- | --- | --- | | Slack Assistant | Remove | The Slack channel documentation covers the same setup and provides more complete guidance for authentication, events, interactivity, and deployment. | | WhatsApp Chat Bot | Remove | The tutorial uses an older manual webhook implementation. The WhatsApp channel adapter is the supported path and includes the relevant setup in one maintained page. | | Web Search | Remove | The built-in `webSearchTool` documentation provides the current provider-agnostic approach and supports the maintained provider integrations. | | Publishing an MCP Server | Move into the MCP overview | Publishing is too narrow for a standalone tutorial, but the stdio entry point, package configuration, and client setup remain useful beside the canonical MCP server documentation. | | Chef Michel | Remove | This is primarily a themed version of the standard agent quickstart and does not teach a distinct Mastra concept. | | Stock Agent | Remove | This duplicates the custom tool quickstart. It also reads the previous trading day's `4. close` value but returns it as `currentPrice` and presents it as the current stock price, which can give readers stale market data under an inaccurate label. | <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This PR removes old tutorials that duplicate maintained documentation. It keeps selected tutorials, moves MCP publishing content to the main MCP page, and redirects old links to current pages. ## Changes - Removed the Slack Assistant, WhatsApp Chat Bot, Web Search, Chef Michel, Stock Agent, and Publishing an MCP Server tutorials. - Retained the Research Assistant, Code Review Bot, and Docs Manager tutorials. - Added MCP stdio server publishing instructions to the MCP overview page. - Pinned the MCP subprocess example to version `1.0.0`. - Updated MCP example links. - Added permanent redirects for removed guide routes and `.llms.txt` routes. - Removed the WhatsApp guide from the feature-versioning map. - Added redirect regression coverage. - No tests were added. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-11 12:47:41 +01:00
2026-08-17 12:17:06 +02:00
docs: remove redundant tutorials (#21238) This removes tutorials that duplicate maintained documentation while preserving the useful MCP publishing guidance on the canonical MCP page. | Tutorial | Action | Rationale | | --- | --- | --- | | Slack Assistant | Remove | The Slack channel documentation covers the same setup and provides more complete guidance for authentication, events, interactivity, and deployment. | | WhatsApp Chat Bot | Remove | The tutorial uses an older manual webhook implementation. The WhatsApp channel adapter is the supported path and includes the relevant setup in one maintained page. | | Web Search | Remove | The built-in `webSearchTool` documentation provides the current provider-agnostic approach and supports the maintained provider integrations. | | Publishing an MCP Server | Move into the MCP overview | Publishing is too narrow for a standalone tutorial, but the stdio entry point, package configuration, and client setup remain useful beside the canonical MCP server documentation. | | Chef Michel | Remove | This is primarily a themed version of the standard agent quickstart and does not teach a distinct Mastra concept. | | Stock Agent | Remove | This duplicates the custom tool quickstart. It also reads the previous trading day's `4. close` value but returns it as `currentPrice` and presents it as the current stock price, which can give readers stale market data under an inaccurate label. | <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This PR removes old tutorials that duplicate maintained documentation. It keeps selected tutorials, moves MCP publishing content to the main MCP page, and redirects old links to current pages. ## Changes - Removed the Slack Assistant, WhatsApp Chat Bot, Web Search, Chef Michel, Stock Agent, and Publishing an MCP Server tutorials. - Retained the Research Assistant, Code Review Bot, and Docs Manager tutorials. - Added MCP stdio server publishing instructions to the MCP overview page. - Pinned the MCP subprocess example to version `1.0.0`. - Updated MCP example links. - Added permanent redirects for removed guide routes and `.llms.txt` routes. - Removed the WhatsApp guide from the feature-versioning map. - Added redirect regression coverage. - No tests were added. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-11 12:47:41 +01:00
2026-08-17 12:17:06 +02:00
docs: remove redundant tutorials (#21238) This removes tutorials that duplicate maintained documentation while preserving the useful MCP publishing guidance on the canonical MCP page. | Tutorial | Action | Rationale | | --- | --- | --- | | Slack Assistant | Remove | The Slack channel documentation covers the same setup and provides more complete guidance for authentication, events, interactivity, and deployment. | | WhatsApp Chat Bot | Remove | The tutorial uses an older manual webhook implementation. The WhatsApp channel adapter is the supported path and includes the relevant setup in one maintained page. | | Web Search | Remove | The built-in `webSearchTool` documentation provides the current provider-agnostic approach and supports the maintained provider integrations. | | Publishing an MCP Server | Move into the MCP overview | Publishing is too narrow for a standalone tutorial, but the stdio entry point, package configuration, and client setup remain useful beside the canonical MCP server documentation. | | Chef Michel | Remove | This is primarily a themed version of the standard agent quickstart and does not teach a distinct Mastra concept. | | Stock Agent | Remove | This duplicates the custom tool quickstart. It also reads the previous trading day's `4. close` value but returns it as `currentPrice` and presents it as the current stock price, which can give readers stale market data under an inaccurate label. | <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This PR removes old tutorials that duplicate maintained documentation. It keeps selected tutorials, moves MCP publishing content to the main MCP page, and redirects old links to current pages. ## Changes - Removed the Slack Assistant, WhatsApp Chat Bot, Web Search, Chef Michel, Stock Agent, and Publishing an MCP Server tutorials. - Retained the Research Assistant, Code Review Bot, and Docs Manager tutorials. - Added MCP stdio server publishing instructions to the MCP overview page. - Pinned the MCP subprocess example to version `1.0.0`. - Updated MCP example links. - Added permanent redirects for removed guide routes and `.llms.txt` routes. - Removed the WhatsApp guide from the feature-versioning map. - Added redirect regression coverage. - No tests were added. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-11 12:47:41 +01:00
2026-08-12 14:17:06 +01:00
2026-08-12 14:17:06 +01:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
2026-08-17 12:17:06 +02:00
docs(signals): reorganize Signals docs into task-based guides (#28022) ## Why The Signals documentation was one 555-line page under **Harness** that tried to cover four different jobs at once: explaining what signals are, showing how to send them, documenting state signals and notifications, and explaining providers and multi-process deployment. Readers had to scan a single long page to find the one task they cared about, and reference-level details were mixed in with the guide. This reorganizes Signals as a first-class section under **Extend** and gives each reader task its own page. The conceptual spine is **signals are input; thread streams are output**. `Agent` stays the primary API; the AgentController `Session` surface is shown as a higher-level mapping, not the default. ## What changed - Added seven Signals guides under `/docs/signals`: - **Overview**: when to use signals, the thread/run/signal/thread-stream model, Quickstart, and choosing an API surface - **Thread streams**: subscribe-before-send, stored history, chunks, approvals, filtering, reconnect, and replay boundaries - **Sending signals**: message and typed-signal input, delivery timing, payloads, cancellation, and the Agent-versus-Session mapping - **State signals**: snapshots and deltas, processor-computed state, deduplication, persistence, and built-in uses - **Notifications**: durable inbox records, deduplication/coalescing, delivery policies, dispatch, retries, and the inbox tool - **Signal providers**: subscriptions, polling, webhooks, lifecycle hooks, processors/tools, and production concerns - **Running across processes**: leases, remote routing, delivery guarantees, crashes, serverless, and shutdown - Moved the section from **Harness** to **Extend**, immediately after **Channels**. - Added `reference/signals/notifications` for `NotificationRecord`, priorities, statuses, delivery decisions, policy evaluation, dispatch configuration, and delivered-signal metadata. - Added `reference/signals/thread-events` for the public `subscribeThreadEvents()` surface and `AgentThreadEvent`. The internal thread-runtime event union is deliberately not documented as public API. - Added the `thread-history` chunk to the `ChunkType` reference, including `messages`, `hasMore`, and the `withInitialHistory` condition. - Moved the Mastra Code cross-agent setup to `docs/src/mastra-code/configuration.mdx` and left a pointer from the Signals overview. - Updated the docs and reference sidebars, inbound links, and page-level redirects from the old Harness routes. - Folded the separate “Signals in the agent loop” draft page into the pages that own its material (Sending signals, Thread streams, Running across processes, Processors, and the tracing overview). ## Test plan - [x] `pnpm --filter mastra-docs test -- --reporter=dot` — 170 tests passed - [x] `pnpm --filter mastra-docs validate:frontmatter` — 679 files passed - [x] `pnpm --filter mastra-docs validate:reference-sidebar` — sort order passed - [x] `pnpm --filter mastra-docs validate:sidebar-docs` — all docs linked - [x] `pnpm --filter mastra-docs format:mdx:check` — 717 MDX files checked - [x] `pnpm --filter mastra-docs lint:remark` — passed - [x] `pnpm --filter mastra-docs exec oxfmt-mdx --check src/mastra-code/configuration.mdx` — passed - [x] `pnpm --filter mastra-docs build` — production build succeeded - [x] `git diff --check` — clean Docs-only change. No runtime, package, dependency, or changeset changes. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> <!-- coderabbit-ai-generated:v1 --> ## ELI5 This PR moves the Signals documentation into a set of task-based guides and updates links from the old pages. It also adds references for notifications and thread events, so readers can find details about how signals and thread updates work. ## Changes - Adds seven guides under **Extend** for the Signals model, thread streams, sending signals, state signals, notifications, providers, and multi-process setup. - Adds reference pages for notifications and thread events, and documents the `thread-history` stream chunk. - Updates the sidebars, links, and permanent redirects for the new documentation paths. - Moves Mastra Code cross-agent setup guidance to its configuration page. - Updates processor documentation with a reactive signal example and documents the `computeStateSignal` processor hook. ## Validation The PR author reports that the documentation tests, validators, formatting checks, build, and `git diff --check` passed. The reported test run had 170 tests. These results were not independently verified. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: mastracode <284800079+mastra-platform[bot]@users.noreply.github.com>
2026-10-22 16:23:52 +02:00
2026-08-17 12:17:06 +02:00
docs(signals): reorganize Signals docs into task-based guides (#28022) ## Why The Signals documentation was one 555-line page under **Harness** that tried to cover four different jobs at once: explaining what signals are, showing how to send them, documenting state signals and notifications, and explaining providers and multi-process deployment. Readers had to scan a single long page to find the one task they cared about, and reference-level details were mixed in with the guide. This reorganizes Signals as a first-class section under **Extend** and gives each reader task its own page. The conceptual spine is **signals are input; thread streams are output**. `Agent` stays the primary API; the AgentController `Session` surface is shown as a higher-level mapping, not the default. ## What changed - Added seven Signals guides under `/docs/signals`: - **Overview**: when to use signals, the thread/run/signal/thread-stream model, Quickstart, and choosing an API surface - **Thread streams**: subscribe-before-send, stored history, chunks, approvals, filtering, reconnect, and replay boundaries - **Sending signals**: message and typed-signal input, delivery timing, payloads, cancellation, and the Agent-versus-Session mapping - **State signals**: snapshots and deltas, processor-computed state, deduplication, persistence, and built-in uses - **Notifications**: durable inbox records, deduplication/coalescing, delivery policies, dispatch, retries, and the inbox tool - **Signal providers**: subscriptions, polling, webhooks, lifecycle hooks, processors/tools, and production concerns - **Running across processes**: leases, remote routing, delivery guarantees, crashes, serverless, and shutdown - Moved the section from **Harness** to **Extend**, immediately after **Channels**. - Added `reference/signals/notifications` for `NotificationRecord`, priorities, statuses, delivery decisions, policy evaluation, dispatch configuration, and delivered-signal metadata. - Added `reference/signals/thread-events` for the public `subscribeThreadEvents()` surface and `AgentThreadEvent`. The internal thread-runtime event union is deliberately not documented as public API. - Added the `thread-history` chunk to the `ChunkType` reference, including `messages`, `hasMore`, and the `withInitialHistory` condition. - Moved the Mastra Code cross-agent setup to `docs/src/mastra-code/configuration.mdx` and left a pointer from the Signals overview. - Updated the docs and reference sidebars, inbound links, and page-level redirects from the old Harness routes. - Folded the separate “Signals in the agent loop” draft page into the pages that own its material (Sending signals, Thread streams, Running across processes, Processors, and the tracing overview). ## Test plan - [x] `pnpm --filter mastra-docs test -- --reporter=dot` — 170 tests passed - [x] `pnpm --filter mastra-docs validate:frontmatter` — 679 files passed - [x] `pnpm --filter mastra-docs validate:reference-sidebar` — sort order passed - [x] `pnpm --filter mastra-docs validate:sidebar-docs` — all docs linked - [x] `pnpm --filter mastra-docs format:mdx:check` — 717 MDX files checked - [x] `pnpm --filter mastra-docs lint:remark` — passed - [x] `pnpm --filter mastra-docs exec oxfmt-mdx --check src/mastra-code/configuration.mdx` — passed - [x] `pnpm --filter mastra-docs build` — production build succeeded - [x] `git diff --check` — clean Docs-only change. No runtime, package, dependency, or changeset changes. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> <!-- coderabbit-ai-generated:v1 --> ## ELI5 This PR moves the Signals documentation into a set of task-based guides and updates links from the old pages. It also adds references for notifications and thread events, so readers can find details about how signals and thread updates work. ## Changes - Adds seven guides under **Extend** for the Signals model, thread streams, sending signals, state signals, notifications, providers, and multi-process setup. - Adds reference pages for notifications and thread events, and documents the `thread-history` stream chunk. - Updates the sidebars, links, and permanent redirects for the new documentation paths. - Moves Mastra Code cross-agent setup guidance to its configuration page. - Updates processor documentation with a reactive signal example and documents the `computeStateSignal` processor hook. ## Validation The PR author reports that the documentation tests, validators, formatting checks, build, and `git diff --check` passed. The reported test run had 170 tests. These results were not independently verified. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: mastracode <284800079+mastra-platform[bot]@users.noreply.github.com>
2026-10-22 16:23:52 +02:00
2026-08-17 12:17:06 +02:00
docs: revert documentation changes from #23077 (#24031) ## Description Reverts the documentation portion of #23077 (the `@mastra/mcp` code and changeset are untouched). - Deletes `docs/src/content/en/docs/connections/connect-mcp-client.mdx` (the "Connect your MCP client to Mastra (draft)" page, which described an unimplemented `mastra mcp` launcher). - Restores `docs/src/content/en/docs/sidebars.js` so the Connections sidebar is a flat `MCP` doc entry again instead of the `Tools & MCP` category that #23077 introduced. The file is byte-identical to its pre-#23077 state. - Restores `docs/src/content/en/reference/tools/mcp-server.mdx` to its pre-#23077 state (removes the "Operate a remote Mastra server" section, which the removed page linked to). Byte-identical to pre-#23077. - Adds a permanent redirect `/docs/connections/connect-mcp-client` → `/docs/connections/mcp` in `vercel.redirects.json` (the page was already live on mastra.ai) and regenerates `vercel.json`, which also produces the `/llms.txt` companion redirect. Verification (from `docs/`): `pnpm format:check`, `pnpm validate`, redirect generator / move-doc / delete-doc script tests (88 passed), `git diff --check`, and `pnpm build`. A repo-wide grep for `connect-mcp-client`, `operate-a-remote-mastra-server`, and "Connect your MCP client" only matches the new redirect entries. ## Related issue(s) Reverts docs from #23077. Requested in Slack (#growth-docs). ## Type of change - [x] Documentation update ## Checklist - [x] I have linked the related issue(s) in the description above - [x] I have made corresponding changes to the documentation (if applicable) - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have addressed all Coderabbit comments on this PR Link to Devin session: https://app.devin.ai/sessions/abf500fe19fe4706b9b274dc6ade0cd2 Open in Devin Desktop: https://app.devin.ai/desktop/session/abf500fe19fe4706b9b274dc6ade0cd2?variant=devin <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This PR removes an unfinished MCP client documentation page and restores the previous MCP documentation. Old links now redirect to the current MCP page. ## Changes - Deleted the draft `connect-mcp-client.mdx` page. - Restored the Connections sidebar structure. - Removed the remote Mastra server section from the MCP server reference. - Added permanent redirects for: - `/docs/connections/connect-mcp-client` - `/docs/connections/connect-mcp-client/llms.txt` - Regenerated `vercel.json`. - Left `@mastra/mcp` code and its changeset unchanged. ## Verification Formatting, validation, redirect tests, diff checks, and the documentation build reportedly passed. <!-- 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>
2026-09-15 19:06:17 +01:00
docs(signals): reorganize Signals docs into task-based guides (#28022) ## Why The Signals documentation was one 555-line page under **Harness** that tried to cover four different jobs at once: explaining what signals are, showing how to send them, documenting state signals and notifications, and explaining providers and multi-process deployment. Readers had to scan a single long page to find the one task they cared about, and reference-level details were mixed in with the guide. This reorganizes Signals as a first-class section under **Extend** and gives each reader task its own page. The conceptual spine is **signals are input; thread streams are output**. `Agent` stays the primary API; the AgentController `Session` surface is shown as a higher-level mapping, not the default. ## What changed - Added seven Signals guides under `/docs/signals`: - **Overview**: when to use signals, the thread/run/signal/thread-stream model, Quickstart, and choosing an API surface - **Thread streams**: subscribe-before-send, stored history, chunks, approvals, filtering, reconnect, and replay boundaries - **Sending signals**: message and typed-signal input, delivery timing, payloads, cancellation, and the Agent-versus-Session mapping - **State signals**: snapshots and deltas, processor-computed state, deduplication, persistence, and built-in uses - **Notifications**: durable inbox records, deduplication/coalescing, delivery policies, dispatch, retries, and the inbox tool - **Signal providers**: subscriptions, polling, webhooks, lifecycle hooks, processors/tools, and production concerns - **Running across processes**: leases, remote routing, delivery guarantees, crashes, serverless, and shutdown - Moved the section from **Harness** to **Extend**, immediately after **Channels**. - Added `reference/signals/notifications` for `NotificationRecord`, priorities, statuses, delivery decisions, policy evaluation, dispatch configuration, and delivered-signal metadata. - Added `reference/signals/thread-events` for the public `subscribeThreadEvents()` surface and `AgentThreadEvent`. The internal thread-runtime event union is deliberately not documented as public API. - Added the `thread-history` chunk to the `ChunkType` reference, including `messages`, `hasMore`, and the `withInitialHistory` condition. - Moved the Mastra Code cross-agent setup to `docs/src/mastra-code/configuration.mdx` and left a pointer from the Signals overview. - Updated the docs and reference sidebars, inbound links, and page-level redirects from the old Harness routes. - Folded the separate “Signals in the agent loop” draft page into the pages that own its material (Sending signals, Thread streams, Running across processes, Processors, and the tracing overview). ## Test plan - [x] `pnpm --filter mastra-docs test -- --reporter=dot` — 170 tests passed - [x] `pnpm --filter mastra-docs validate:frontmatter` — 679 files passed - [x] `pnpm --filter mastra-docs validate:reference-sidebar` — sort order passed - [x] `pnpm --filter mastra-docs validate:sidebar-docs` — all docs linked - [x] `pnpm --filter mastra-docs format:mdx:check` — 717 MDX files checked - [x] `pnpm --filter mastra-docs lint:remark` — passed - [x] `pnpm --filter mastra-docs exec oxfmt-mdx --check src/mastra-code/configuration.mdx` — passed - [x] `pnpm --filter mastra-docs build` — production build succeeded - [x] `git diff --check` — clean Docs-only change. No runtime, package, dependency, or changeset changes. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> <!-- coderabbit-ai-generated:v1 --> ## ELI5 This PR moves the Signals documentation into a set of task-based guides and updates links from the old pages. It also adds references for notifications and thread events, so readers can find details about how signals and thread updates work. ## Changes - Adds seven guides under **Extend** for the Signals model, thread streams, sending signals, state signals, notifications, providers, and multi-process setup. - Adds reference pages for notifications and thread events, and documents the `thread-history` stream chunk. - Updates the sidebars, links, and permanent redirects for the new documentation paths. - Moves Mastra Code cross-agent setup guidance to its configuration page. - Updates processor documentation with a reactive signal example and documents the `computeStateSignal` processor hook. ## Validation The PR author reports that the documentation tests, validators, formatting checks, build, and `git diff --check` passed. The reported test run had 170 tests. These results were not independently verified. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: mastracode <284800079+mastra-platform[bot]@users.noreply.github.com>
2026-10-22 16:23:52 +02:00
docs(signals): reorganize Signals docs into task-based guides (#28022) ## Why The Signals documentation was one 555-line page under **Harness** that tried to cover four different jobs at once: explaining what signals are, showing how to send them, documenting state signals and notifications, and explaining providers and multi-process deployment. Readers had to scan a single long page to find the one task they cared about, and reference-level details were mixed in with the guide. This reorganizes Signals as a first-class section under **Extend** and gives each reader task its own page. The conceptual spine is **signals are input; thread streams are output**. `Agent` stays the primary API; the AgentController `Session` surface is shown as a higher-level mapping, not the default. ## What changed - Added seven Signals guides under `/docs/signals`: - **Overview**: when to use signals, the thread/run/signal/thread-stream model, Quickstart, and choosing an API surface - **Thread streams**: subscribe-before-send, stored history, chunks, approvals, filtering, reconnect, and replay boundaries - **Sending signals**: message and typed-signal input, delivery timing, payloads, cancellation, and the Agent-versus-Session mapping - **State signals**: snapshots and deltas, processor-computed state, deduplication, persistence, and built-in uses - **Notifications**: durable inbox records, deduplication/coalescing, delivery policies, dispatch, retries, and the inbox tool - **Signal providers**: subscriptions, polling, webhooks, lifecycle hooks, processors/tools, and production concerns - **Running across processes**: leases, remote routing, delivery guarantees, crashes, serverless, and shutdown - Moved the section from **Harness** to **Extend**, immediately after **Channels**. - Added `reference/signals/notifications` for `NotificationRecord`, priorities, statuses, delivery decisions, policy evaluation, dispatch configuration, and delivered-signal metadata. - Added `reference/signals/thread-events` for the public `subscribeThreadEvents()` surface and `AgentThreadEvent`. The internal thread-runtime event union is deliberately not documented as public API. - Added the `thread-history` chunk to the `ChunkType` reference, including `messages`, `hasMore`, and the `withInitialHistory` condition. - Moved the Mastra Code cross-agent setup to `docs/src/mastra-code/configuration.mdx` and left a pointer from the Signals overview. - Updated the docs and reference sidebars, inbound links, and page-level redirects from the old Harness routes. - Folded the separate “Signals in the agent loop” draft page into the pages that own its material (Sending signals, Thread streams, Running across processes, Processors, and the tracing overview). ## Test plan - [x] `pnpm --filter mastra-docs test -- --reporter=dot` — 170 tests passed - [x] `pnpm --filter mastra-docs validate:frontmatter` — 679 files passed - [x] `pnpm --filter mastra-docs validate:reference-sidebar` — sort order passed - [x] `pnpm --filter mastra-docs validate:sidebar-docs` — all docs linked - [x] `pnpm --filter mastra-docs format:mdx:check` — 717 MDX files checked - [x] `pnpm --filter mastra-docs lint:remark` — passed - [x] `pnpm --filter mastra-docs exec oxfmt-mdx --check src/mastra-code/configuration.mdx` — passed - [x] `pnpm --filter mastra-docs build` — production build succeeded - [x] `git diff --check` — clean Docs-only change. No runtime, package, dependency, or changeset changes. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> <!-- coderabbit-ai-generated:v1 --> ## ELI5 This PR moves the Signals documentation into a set of task-based guides and updates links from the old pages. It also adds references for notifications and thread events, so readers can find details about how signals and thread updates work. ## Changes - Adds seven guides under **Extend** for the Signals model, thread streams, sending signals, state signals, notifications, providers, and multi-process setup. - Adds reference pages for notifications and thread events, and documents the `thread-history` stream chunk. - Updates the sidebars, links, and permanent redirects for the new documentation paths. - Moves Mastra Code cross-agent setup guidance to its configuration page. - Updates processor documentation with a reactive signal example and documents the `computeStateSignal` processor hook. ## Validation The PR author reports that the documentation tests, validators, formatting checks, build, and `git diff --check` passed. The reported test run had 170 tests. These results were not independently verified. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: mastracode <284800079+mastra-platform[bot]@users.noreply.github.com>
2026-10-22 16:23:52 +02:00