docs: prepare 0.18 doc release #1493
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Documentation preview |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Greptile Overview
Greptile Summary
This PR updates documentation for the upcoming 0.18.0 release, including version metadata, release notes, and cross-reference anchors.
Key changes:
- Updated version to 0.18.0 in
project.jsonandversions1.json - Added comprehensive release notes documenting two major features: in-memory caching for guardrail models (using LFU cache) and bot reasoning trace extraction with
BotThinkingevents - Added MyST anchor label to bot-thinking-guardrails guide to enable cross-referencing from release notes
- All cross-reference links validated and point to existing documentation pages
Note: This PR prepares documentation only - the package version in pyproject.toml:7 remains at 0.17.0 and will need to be updated separately before the actual release.
Confidence Score: 5/5
- This PR is safe to merge with no risk - contains only documentation updates
- All changes are documentation-only with no code modifications. Version bumps are consistent across documentation files, release notes accurately reflect features from recent commits, and all cross-reference anchors point to existing documentation pages that have already been merged.
- No files require special attention
Important Files Changed
File Analysis
| Filename | Score | Overview |
|---|---|---|
| docs/project.json | 5/5 | Simple version bump from 0.17.0 to 0.18.0 in project metadata |
| docs/versions1.json | 5/5 | Added 0.18.0 as the preferred version in documentation versions list |
| docs/release-notes.md | 5/5 | Added release notes for v0.18.0 with key features (in-memory caching, bot reasoning traces) and fixed issues |
| docs/user-guides/advanced/bot-thinking-guardrails.md | 5/5 | Added MyST anchor label for cross-referencing from release notes |
Sequence Diagram
sequenceDiagram
participant Dev as Developer
participant Docs as Documentation Files
participant Project as project.json
participant Versions as versions1.json
participant Release as release-notes.md
participant Guide as bot-thinking-guardrails.md
Dev->>Project: Update version to 0.18.0
Dev->>Versions: Add 0.18.0 as preferred version
Dev->>Guide: Add MyST anchor label (bot-thinking-guardrails)
Dev->>Release: Add 0.18.0 release notes section
Release->>Release: Document key features (caching, reasoning traces)
Release->>Release: Document fixed issues (validation)
Release->>Guide: Reference bot-thinking-guardrails anchor
Release->>Docs: Reference model-memory-cache anchor
Dev->>Docs: Commit documentation updates
Note over Dev,Docs: Documentation prepared for 0.18 release
4 files reviewed, no comments
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
cparisien
reviewed
Nov 5, 2025
Contributor
There was a problem hiding this comment.
Greptile Overview
Greptile Summary
This PR completes the documentation updates for the 0.18.0 release by adding two additional feature bullet points to the release notes.
Key changes:
- Added Cisco AI Defense community integration feature to release notes (verified integration exists at
docs/user-guides/community/ai-defense.md) - Added new embedding integrations feature for Azure OpenAI, Google, and Cohere (verified implementations exist in
nemoguardrails/embeddings/providers/) - Updated version numbers across documentation files (
project.json,versions1.json) - Added cross-reference label to
bot-thinking-guardrails.mdto enable proper linking from release notes
All referenced features and documentation pages exist and are properly implemented in the codebase.
Confidence Score: 5/5
- This PR is safe to merge with no risk
- This is a documentation-only PR that adds feature descriptions to release notes. All referenced features, integrations, and documentation pages have been verified to exist in the codebase. The changes are purely informational, require no code execution, and follow the established release notes format.
- No files require special attention
Important Files Changed
File Analysis
| Filename | Score | Overview |
|---|---|---|
| docs/release-notes.md | 5/5 | Adds two new feature bullet points to 0.18.0 release notes: Cisco AI Defense integration and new embedding integrations (Azure OpenAI, Google, Cohere) |
| docs/project.json | 5/5 | Updates version number from 0.17.0 to 0.18.0 |
| docs/user-guides/advanced/bot-thinking-guardrails.md | 5/5 | Adds reference label (bot-thinking-guardrails)= to enable cross-document linking |
| docs/versions1.json | 5/5 | Adds 0.18.0 as the new preferred version and shifts previous versions down |
Sequence Diagram
sequenceDiagram
participant Dev as Developer
participant Docs as Documentation System
participant Version as Version Control
Dev->>Docs: Update release notes (0.18.0)
Note over Docs: Add Cisco AI Defense feature
Note over Docs: Add embedding integrations feature
Dev->>Version: Update project.json version
Version-->>Version: 0.17.0 → 0.18.0
Dev->>Docs: Add cross-reference label
Note over Docs: bot-thinking-guardrails.md
Dev->>Version: Update versions1.json
Note over Version: Mark 0.18.0 as preferred
Note over Version: Shift previous versions
Docs->>Docs: Enable cross-document linking
Docs-->>Dev: Documentation ready for 0.18.0 release
1 file reviewed, no comments
Contributor
There was a problem hiding this comment.
Greptile Overview
Greptile Summary
This PR adds the v0.18.0 release notes to the documentation, documenting new features and bug fixes for this release.
Key changes:
- Added in-memory caching of guardrail model calls using LFU cache for reduced latency and cost savings
- Added support for LLM reasoning traces extraction as
BotThinkingevents - Documented new Cisco AI Defense community integration
- Documented new embedding integrations (Azure OpenAI, Google, Cohere)
- Added note about validation improvements for content safety and topic control guardrails
Documentation quality:
- Follows consistent formatting with previous release notes (v0.17.0, v0.16.0, etc.)
- Uses proper MyST markdown reference links to internal documentation
- All referenced documentation sections exist (
model-memory-cacheandbot-thinking-guardrails) - Properly structured with section anchors for cross-referencing
Confidence Score: 5/5
- This PR is safe to merge with no risk
- This is a straightforward documentation-only change that adds release notes for v0.18.0. The changes follow the established format, all internal documentation references are valid, and the content aligns with standard release note practices
- No files require special attention
Important Files Changed
File Analysis
| Filename | Score | Overview |
|---|---|---|
| docs/release-notes.md | 5/5 | Added v0.18.0 release notes section with key features and fixed issues, following existing documentation format and structure |
Sequence Diagram
sequenceDiagram
participant Dev as Developer
participant Doc as docs/release-notes.md
participant Refs as Referenced Docs
participant Users as Documentation Users
Dev->>Doc: Add v0.18.0 release section
Dev->>Doc: Document key features (caching, reasoning traces)
Dev->>Doc: Add community integrations (Cisco AI Defense)
Dev->>Doc: Document embedding integrations
Dev->>Doc: Add fixed issues section
Doc->>Refs: Reference model-memory-cache guide
Doc->>Refs: Reference bot-thinking-guardrails guide
Refs-->>Doc: Links validated
Dev->>Doc: Apply consistent formatting
Doc->>Users: Publish v0.18.0 release notes
1 file reviewed, no comments
tgasser-nv
approved these changes
Nov 5, 2025
Collaborator
tgasser-nv
left a comment
tgasser-nv
left a comment
There was a problem hiding this comment.
Looks good, please merge
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Related Issue(s)
Checklist