## Description
Fixes minor documentation issues:
- Capitalized "Markdown"
- Corrected numbering in the Vale section
## Related Issue(s)
N/A
## Type of Change
- [x] Documentation update
## Checklist
- [x] I have made corresponding changes to the documentation (if
applicable)
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## ELI5
This PR fixes two small documentation formatting issues: it corrects the
capitalization of the word "Markdown" and fixes the numbering sequence
in the Vale linting setup instructions to be in proper order (1, 2, 3).
## Changes
### Documentation Updates
The `docs/README.md` file has been updated with two corrections:
1. **Markdown Capitalization**: The word "Markdown" in the Remark
linting section is now properly capitalized in the instruction text.
2. **Vale Setup Numbering**: The numbered list for Vale linting setup
has been corrected:
- Step 2: Installation of `mdx2vast` (dependency for linting MDX files)
- Step 3: Running the Vale linter command
These changes ensure proper documentation formatting and improved
readability for users following the linting setup instructions.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: Ward Peeters <ward@coding-tech.com>
## 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>
## Description
Diff feature for the docs
Use `[!code ++]` and `[!code --]` to mark added and removed lines.
Example Usage:
<img width="653" height="268" alt="image"
src="https://github.com/user-attachments/assets/d3307fe3-548e-4a62-8943-d5f3a17b8474"
/>
Docs Preview:
<img width="1328" height="526" alt="CleanShot 2025-07-14 at 17 47 48@2x"
src="https://github.com/user-attachments/assets/c85fac17-ea8d-4b34-b722-622e1f89d816"
/>
## 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
---------
Co-authored-by: Paul Scanlon <pauliescanlon@gmail.com>
Co-authored-by: wardpeet <ward@coding-tech.com>
## Description
Switch to Algolia search
- Shows locale specific search results automatically
- Re-indexes docs content daily
## 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
---------
Co-authored-by: Abhi Aiyer <abhiaiyer91@gmail.com>
## Description
Remove the `.env` from the docs content
## Type of Change
- [x] Documentation update
## Checklist
- [x] I have performed a self-review of my own code
## Description
This Readme details how to pull the docs repo, add env variable, install
deps and run the dev server.
It also includes guidelines for adding new content.
## 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
- [x] I have performed a self-review of my own code