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

54 commits

Author SHA1 Message Date
mastra-platform[bot]
95c9fa97f1
fix(docs): fail pnpm check when Vale is missing (#30334) 2026-11-13 10:42:46 -07:00
mastra-platform[bot]
892134ca8e
docs: advertise the agent discovery manifest in the docs Link header (#29921) 2026-11-10 11:27:54 -07:00
mastra-platform[bot]
51a20e848e
feat(docs): one pnpm check command for all docs checks, with JSON output and stable rule IDs (#29801)
Co-authored-by: LekoArts <lekoarts@gmail.com>
2026-11-09 16:59:20 -07:00
Lennart
ee5a1b0282
docs: make packages frontmatter more precise (#29499)
Co-authored-by: mastracode <284800079+mastra-platform[bot]@users.noreply.github.com>
2026-11-04 17:49:54 -08:00
mastra-platform[bot]
e953b26939
docs: close eight documentation gaps across agents, streaming, memory, evals and deployment (#28858) 2026-10-29 15:36:35 +01:00
mastra-platform[bot]
a89886b5e9
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
Lennart
ac0a24c2a8
docs: strengthen authoring guardrails and prose lint workflow (#28256)
Co-authored-by: mastracode <284800079+mastra-platform[bot]@users.noreply.github.com>
2026-10-23 14:34:31 +02:00
Lennart
00db355738
docs: improve agent-facing llms.txt and clear Vale AI-tell findings (#25437)
Co-authored-by: mastracode <284800079+mastra-platform[bot]@users.noreply.github.com>
2026-09-29 07:44:10 -07:00
Lennart
5c6421d14a
docs: update Vale and tune rules for technical prose (#23415) 2026-09-09 14:56:34 +02:00
Lennart
7349f4d3ef
fix(docs): normalize canonical section root URLs (#22760) 2026-09-01 07:42:28 -07:00
Lennart
8c8b0e323b
chore(docs): Update Vale (#22686) 2026-09-01 10:08:51 +02:00
Lennart
4c7c85ac0f
chore(docs): Update skill & styleguides (#21754) 2026-08-18 16:42:28 +02:00
Lennart
510e23be6c
chore(docs): Update URLs (#21643) 2026-08-17 12:17:06 +02:00
Lennart
dc7bf3a2c2
chore(docs): Update Vale version (#21405) 2026-08-13 14:44:37 +02:00
Lennart
be823d2268
chore(docs): Various follow-ups (#21399) 2026-08-13 14:03:13 +02:00
Alex Booker
ea3bea4c50
docs: retire guides section (#21329) 2026-08-12 15:17:06 +02:00
Alex Booker
b9ae1fe371
docs: add integrations section (#20924)
Co-authored-by: LekoArts <lekoarts@gmail.com>
2026-08-11 16:08:00 +02:00
Lennart
b77bd6f8b5
feat(docs): add contextual sidebar state model (#20740) 2026-08-06 14:55:43 +02:00
Lennart
fa8faf9e7c
chore(docs): Consolidate AgentController docs (#20726)
Co-authored-by: Mastra Code (openai/gpt-5.6-sol) <noreply@mastra.ai>
2026-08-05 11:33:25 +02:00
Lennart
472cdb062d
chore(docs): Remove Agent Builder (#20640) 2026-08-04 12:21:51 +02:00
Lennart
e6a9e6b022
chore(docs): Use oxfmt (#20305) 2026-07-28 16:35:37 +02:00
Lennart
58fdbb2548
chore(docs): Move storage/project structure (#19049) 2026-07-08 11:54:37 +02:00
Lennart
25ae2bbd90
chore(docs): Sidebar reorganization (#18778)
Co-authored-by: Alex Booker <booker@booker.codes>
2026-07-03 10:07:21 +02:00
Lennart
8c62e0c511
chore(docs): Improve llms.txt generation & discoverability (#18788) 2026-07-02 12:37:23 +02:00
Lennart
7f8481da53
chore(docs): Augment redirects with /llms.txt variants (#18722) 2026-07-01 10:43:48 +02:00
Lennart
d46910a3f8
chore(docs): Refactor sidebar, move platform, reduce streaming (#18354) 2026-06-23 15:40:25 +02:00
Lennart
ed4dc9a821
chore(docs): Remove outdated "new" tags (#18297) 2026-06-22 13:25:18 +02:00
Lennart
3ffd9a7e16
chore(docs): Update Studio/Server (#15193)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2026-04-09 08:20:05 -07:00
Lennart
2d713d0e56
feat(docs): Studio category (#14669) 2026-03-31 15:54:38 +02:00
Lennart
c8f4e36a76
chore(docs): Begin sentence case enforcement (#14083) 2026-03-11 10:09:15 +01:00
Lennart
83fc51c2fc
chore(docs): More vale linting (#13995) 2026-03-09 10:57:08 +01:00
Lennart
333d6b2c47
chore(docs): Remove 1.0 banner (#13672)
## Description

- Remove 1.0 banner
- Update `/guides` index page to include the same cards as the getting
started page (trying out MDX partials)

## 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

* **Documentation**
* Added a reusable "Start" cards section showcasing quickstart and
framework integration guides (Next.js, React, SvelteKit, Astro, Nuxt,
Express, Hono, Electron)
* Replaced scattered card markup with the centralized Start cards
section across getting-started and guides pages
  * Updated introductory copy for guides

* **Chores**
  * Removed a promotional banner from the main documentation layout
  * Sidebar validation now ignores partial/fragment documentation files
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-03-02 15:07:29 +00:00
Shane Thomas
439dd1a1c9
chore(docs): Move Mastra Code docs, add Alpha notice to Harness (#13525)
Co-authored-by: Mastra Code (anthropic/claude-opus-4-6) <noreply@mastra.ai>
Co-authored-by: LekoArts <lekoarts@gmail.com>
2026-02-26 10:10:04 +01:00
Lennart
aef1376f6b
chore(repo,docs): Add CI & improve styleguide (#13449) 2026-02-24 15:52:41 +01:00
Lennart
f73316a5e8
chore(docs): Small formatting fixes (#13402)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2026-02-23 15:33:34 +01:00
Lennart
8373be8632
chore(docs): Add "Deploying Studio" guide (#12956) 2026-02-12 10:44:22 +01:00
Lennart
130c0ff642
chore(docs): Add "Build with AI" pages/category (#12628)
## Description

Add "Build with AI" category and skills subpage

## 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**
* Added Skills documentation page and a new "Build with AI" guide
covering Skills, MCP Docs Server, embedded docs, and usage tips.

* **Documentation**
* Reorganized sidebar to surface "Build with AI" content and updated MCP
Docs Server and Workspace Skills pages.
* Minor content edits across quickstart, memory docs, and observational
anchors.

* **Chores**
* Added permanent redirect for MCP Docs Server and refined
pagination/footer styling for docs UI.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2026-02-05 11:25:44 +01:00
Lennart
57a8fb9165
feat(mcp-docs-server): Remove tools, use llms.txt instead of raw MDX (#12623) 2026-02-04 10:14:55 +01:00
Lennart
4af836f642
feat(docs): Add llms.txt to every route (#12466)
## Description

Add a build plugin (that only runs during `docusaurus build`) that
generates `llms.txt` files alongside each docs page with the contents of
each page.

More open in options:

<img width="322" height="294" alt="image"
src="https://github.com/user-attachments/assets/7029101d-6cf6-40ad-8c26-3878e288256a"
/>

New footer with link to llms.txt file:

<img width="361" height="73" alt="image"
src="https://github.com/user-attachments/assets/9885606f-dbde-4763-bfd1-4b711b3945c0"
/>

## 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**
* Per-page and site root llms.txt files are now generated for easier LLM
integration.
* Reworked page actions: a compact "Copy / Open in" menu provides quick,
data-driven links to external AI assistants and a direct llms.txt link.

* **Documentation**
* Standardized internal cross-reference links across storage and
observability docs.
* Clarified observability guidance and related warnings in multiple
storage pages.

<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-01-29 10:26:02 -08:00
Lennart
66ef41bea0
chore(docs): Remove tech debt (first pass) (#12354)
## Description

A first pass at removing tech debt from docs and enforcing consistent
styling through lint-staged and working prettier config.

## 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
2026-01-27 15:17:56 +01:00
Lennart
0d9a2d32d6
chore(docs): Improve llms & mcp docs (#12304) 2026-01-26 14:17:57 +01:00
Lennart
175790bfdc
chore(docs): Fix llms.txt (#12149) 2026-01-21 15:25:00 +01:00
Lennart
fbfa8659b4
chore(docs): Misc fixes (#12133)
## Description

Misc hotfixes for docs

## 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

* **Documentation**
* Updated navigation links in search empty-state to correct
documentation paths.
* Updated migration guide reference link to point to new documentation
location.

* **Chores**
* Added validation tool to verify redirect configurations for
consistency and accuracy.
* Removed redundant self-referencing redirects to streamline redirect
configuration.

<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-01-21 08:45:10 +01:00
Lennart
5f7b9b2078
feat(docs): Stable v1 (#12002) 2026-01-20 17:22:17 +01:00
Ehindero Israel
bc72b529ee
feat: embedded documentation for AI coding agents (#11472)
## Summary

Enables Mastra packages to ship embedded documentation that AI coding
agents can read directly from `node_modules`. This allows agents to
understand the framework as if they were its creators.

## What's Included

### Infrastructure
- **`scripts/generate-package-docs.ts`** - Shared script to generate
docs from MDX sources
- **`SOURCE_MAP.json`** - Machine-readable index mapping exports → types
→ implementation (with line numbers)
- **`SKILL.md`** - Claude Skills entry point for automatic discovery
- **`EMBEDDED_DOCS.md`** - Guide for adding embedded docs to any package

### Package Coverage (47 packages)
- **Core:** memory, rag, evals, mcp, server, auth, deployer, cli,
client-js, loggers
- **Voice:** 13 providers (openai, deepgram, elevenlabs, etc.)
- **Stores:** 22 providers (pg, libsql, pinecone, etc.)

Each package gets:
- `docs.config.json` - Topic/source file mappings
- `postbuild` script - Auto-generates `dist/docs/` after build

## How It Works

1. MDX docs are transformed to clean Markdown (Docusaurus components
stripped, code blocks preserved)
2. Code references are auto-discovered from imports/usage and linked to
SOURCE_MAP
3. Docs are generated to `dist/docs/` on every build
4. Published to npm alongside the package

## Example Output
node_modules/@mastra/core/dist/docs/
├── SKILL.md # Agent entry point
├── README.md # Navigation
├── SOURCE_MAP.json # Export → file mappings
├── agents/
 │ ├── 01-overview.md
 │ └── ...
└── tools/
└── ...


## Related

- Follow-up PR for MCP tools: #11488

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

## Summary by CodeRabbit

* **New Features**
* Embedded package documentation is now automatically generated and
included in published npm packages, making documentation accessible
directly within package distributions and enabling integration with AI
tools and Claude Skills.

* **Documentation**
* Added comprehensive embedded documentation guide for generating and
integrating documentation from source files into package distributions.

<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-30 16:39:28 -08:00
Marco Lombardi
907f54eb85
docs: fix typos in docs (#9980)
Co-authored-by: LekoArts <lekoarts@gmail.com>
2025-11-12 10:17:38 +01:00
Tyler Barnes
fb6418394d
chore: add llms.txt generation to provider workflow (#9474)
Adds automatic regeneration of `llms.txt` and `llms-full.txt` files to
the scheduled provider documentation workflow.

## Changes

- Renamed workflow from "Regenerate Provider Registry" to "Regenerate
Providers & Docs"
- Added step to regenerate llms.txt files after model docs generation
- Updated git diff check to include the llms.txt files
- Updated commit messages and logs to reflect broader scope

## Why

The llms.txt files were previously generated manually. Now they'll be
automatically regenerated every 6 hours along with the provider registry
and model documentation, keeping them up-to-date with the latest
content.

**Before:**
```yaml
- name: Generate model documentation
  run: pnpx tsx packages/core/scripts/generate-model-docs.ts
```

**After:**
```yaml
- name: Generate model documentation
  run: pnpx tsx packages/core/scripts/generate-model-docs.ts

- name: Generate llms.txt files
  run: pnpx tsx docs/scripts/build-llms-text-files.ts
```

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

## Summary by CodeRabbit

* **Chores**
* Updated workflow to regenerate providers and documentation together,
improving coordination of updates.
  * Added automated generation of llms.txt documentation files.
* Enhanced change detection to include documentation files in the
workflow process.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-10-29 13:49:03 -07:00
Tyler Barnes
b75ef77bbb
fix: remove Japanese content from llms.txt files to reduce size (#9471)
This removes Japanese content from the llms.txt generation script since
LLMs are multilingual and English documentation is sufficient.

The script was processing both English and Japanese directories,
resulting in very large files (llms.txt was 78k tokens, llms-full.txt
was 1.7M tokens).

Before:
```typescript
const enDir = path.join(contentDir, 'en');
const jaDir = path.join(contentDir, 'ja');

const enDocs = await processDirectory(enDir, 'en');
const jaDocs = await processDirectory(jaDir, 'ja');
const allDocs = [...enDocs, ...jaDocs];
```

After:
```typescript
const enDir = path.join(contentDir, 'en');

const enDocs = await processDirectory(enDir, 'en');
const allDocs = [...enDocs];
```

This should significantly reduce the file sizes while maintaining full
functionality since the English docs contain all the necessary
information for LLMs.

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

## Summary by CodeRabbit

## Chores
* Simplified documentation build process by consolidating to
English-only support, removing Japanese documentation processing to
streamline the build workflow.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-10-29 13:32:17 -07:00
Kehinde
34d473f38c
Kenny/grwth 952 migrate old nextra docs to docusarurus (#9391)
## Description

Migration of Nextra docs to Docusaurus.

## Related Issue(s)

<!-- Link to the issue(s) this PR addresses, using hashtag notation:
#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)
- [ ] 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

* **Documentation**
* Removed a large set of docs in the docs-new directory, including
guides, examples, and reference pages across Agents, Auth, Deployment,
Examples, Evals, RAG, Memory, Observability, and Processors.

* **Chores**
  * Updated redirect validation configuration source.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Paul Scanlon <pauliescanlon@gmail.com>
Co-authored-by: LekoArts <lekoarts@gmail.com>
2025-10-29 14:46:15 +01:00
Ward Peeters
81d1940a14
docs ignore (#5302)
Update docs ignore step
2025-06-20 13:20:27 -07:00