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

18 commits

Author SHA1 Message Date
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
Lennart
6f5a36d8f9
chore(repo): Mention new PR policy (#27829) 2026-10-20 08:38:31 -07:00
Lennart
8c8b0e323b
chore(docs): Update Vale (#22686) 2026-09-01 10:08:51 +02:00
devin-ai-integration[bot]
9140cacd9d
docs(sidebar): drop Beta badges in Harness, replace remaining Beta badges with New (#21150)
## Description

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

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

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

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

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

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

`pnpm validate` passes.

## Related issue(s)

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

## Type of change

- [x] Documentation update

## Checklist

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


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

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

## ELI5

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

## Changes

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

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

---------

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: alex <alex@mastra.ai>
Co-authored-by: Alex Booker <booker@booker.codes>
2026-08-10 16:03:40 +01:00
Lennart
ff4106b87b
chore(docs): Remove remnants of JP i18n (#20635) 2026-08-03 15:58:27 +02:00
Lennart
0956d9a93f
chore(docs): Add Vale to CI (#20515) 2026-07-31 12:21:33 +02:00
Lennart
7f8481da53
chore(docs): Augment redirects with /llms.txt variants (#18722) 2026-07-01 10:43:48 +02:00
Lennart
b4df252e80
chore(docs): Improve internal agent hints for linting (#18700) 2026-06-30 17:08:33 +02:00
Lennart
83fc51c2fc
chore(docs): More vale linting (#13995) 2026-03-09 10:57:08 +01:00
Caleb Barnes
838cd327d0
docs(workspace): add SandboxProcessManager and background process docs (#13430)
Co-authored-by: CalebBarnes <CalebBarnes@users.noreply.github.com>
Co-authored-by: Mastra Code (anthropic/claude-opus-4-6) <noreply@mastra.ai>
Co-authored-by: Lennart <lekoarts@gmail.com>
2026-03-06 11:38:52 +01:00
Lennart
5cdae815ab
chore(docs): Add prettier formatting, local remark & vale linting (#13320) 2026-02-23 12:20:08 +01:00
Lennart
b6fd5edf56
chore: Add docs styleguides (#13263)
## Description

- Add docs styleguides
- Add AGENTS.md files and point CLAUDE.md file to it
- Add mastra-docs claude skill
- Improve prompts on writing docs

## Related Issue(s)

Fixes DEVED-110

## 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 comprehensive docs and styleguides (DOC, STYLEGUIDE, GUIDE_* ,
REFERENCE) and new AGENTS.md; reorganized docs content and contributor
workflow.
* Replaced extensive CLAUDE.md content with pointer to AGENTS.md;
cleared docs changelog and removed some legacy guideline files.
* Updated CLI/pr/changeset prompts and guidance to require multiple
changesets for multi-package changes and warn against very long
changesets.

* **Community**
* Updated Code of Conduct with expanded scope and clearer enforcement
guidance.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2026-02-19 13:45:33 +01:00
Lennart
d2af4c8230
chore(docs): Move to pnpm (#12578)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2026-02-02 15:01:09 +01: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
289f85c48d
fix(deployer): Windows paths (#11639)
## Description

- Get `pnpm build` on windows machine working
- Fix the node-modules-resolver by checking with `isAbsolute` so that
windows `C:` paths are not looked at

## Related Issue(s)

Fixes #11508

## Type of Change

- [X] 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

* **Bug Fixes**
* Fixed module resolution to skip absolute Windows-style paths and
corrected node_modules checking on Windows.

* **Tests**
  * Added test coverage for absolute Windows paths.

* **Documentation**
  * Updated contributing guide links.

* **Chores**
* Removed a configuration file, adjusted project ignore patterns, and
improved internal path resolution and type safety across packages.

<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-06 08:28:27 -08: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
Lennart
75136488da
chore: Improve internal docs and bug report template (#10159)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2025-11-17 13:59:22 +01:00