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

136 lines
5.4 KiB

2024-10-03 10:37:36 +01:00
2024-10-03 10:37:36 +01:00
2024-10-03 10:37:36 +01:00
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 19:26:02 +01:00
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-31 01:39:28 +01:00
2026-08-12 14:17:06 +01:00
2026-08-12 14:17:06 +01:00
2026-08-12 14:17:06 +01:00
2024-10-03 10:37:36 +01:00
2026-07-28 15:35:37 +01:00
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 19:26:02 +01:00
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 19:26:02 +01:00
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 19:26:02 +01:00
2024-10-03 10:37:36 +01:00
chore: upgrade Tailwind CSS to 4.3.3 (#20171) Updates Tailwind CSS and its CLI, PostCSS, and Vite integrations to 4.3.3 across Playground, the React client, docs, and MastraCode web. This aligns the mixed 4.2.2/4.3.0 toolchain and makes the v4.3 scrollbar utilities already used by MessageScroller available in the generated Playground UI CSS. The local Tailwind guidance is updated too. Validated with frozen installs, the Playground UI and full Playground dependency-graph builds, the docs build, the MastraCode web build, and the Playground UI typecheck. Confirmed the autoscroll thumb and track utilities are emitted in dist/style.css. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This updates Tailwind and related tools to the same newer version across the project. It fixes transparent scrollbars in the Playground and makes newer styling utilities available. ## Changes - Upgraded Tailwind CSS 4.3.3 and related CLI, PostCSS, and Vite integrations across: - Playground - Playground UI - React client - Documentation - MastraCode web - Enabled v4.3 scrollbar utilities used by `MessageScroller`. - Updated Tailwind v4 local guidance to reference the new version and utilities. - Added a patch changeset for the Playground UI scrollbar fix. ## Validation - Completed frozen installs and builds for the Playground UI, dependency graph, docs, and MastraCode web. - Typechecked the Playground UI. - Confirmed scrollbar utilities are emitted in `dist/style.css`. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-07-27 10:24:07 +02:00
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 19:26:02 +01:00
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 19:26:02 +01:00
chore: upgrade Tailwind CSS to 4.3.3 (#20171) Updates Tailwind CSS and its CLI, PostCSS, and Vite integrations to 4.3.3 across Playground, the React client, docs, and MastraCode web. This aligns the mixed 4.2.2/4.3.0 toolchain and makes the v4.3 scrollbar utilities already used by MessageScroller available in the generated Playground UI CSS. The local Tailwind guidance is updated too. Validated with frozen installs, the Playground UI and full Playground dependency-graph builds, the docs build, the MastraCode web build, and the Playground UI typecheck. Confirmed the autoscroll thumb and track utilities are emitted in dist/style.css. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## ELI5 This updates Tailwind and related tools to the same newer version across the project. It fixes transparent scrollbars in the Playground and makes newer styling utilities available. ## Changes - Upgraded Tailwind CSS 4.3.3 and related CLI, PostCSS, and Vite integrations across: - Playground - Playground UI - React client - Documentation - MastraCode web - Enabled v4.3 scrollbar utilities used by `MessageScroller`. - Updated Tailwind v4 local guidance to reference the new version and utilities. - Added a patch changeset for the Playground UI scrollbar fix. ## Validation - Completed frozen installs and builds for the Playground UI, dependency graph, docs, and MastraCode web. - Typechecked the Playground UI. - Confirmed scrollbar utilities are emitted in `dist/style.css`. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-07-27 10:24:07 +02:00
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
2024-10-03 10:37:36 +01:00