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

266 lines
8 KiB

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
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
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
2026-07-31 12:21:33 +02:00
2026-07-31 12:21:33 +02:00
2026-09-01 10:08:51 +02:00
2026-07-31 12:21:33 +02:00
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
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
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
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
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
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
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
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
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
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
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
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
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
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
2026-07-31 12:21:33 +02:00
2026-07-31 12:21:33 +02:00
2026-07-31 12:21:33 +02:00
2026-07-31 12:21:33 +02:00
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
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
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
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
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
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
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