-
Notifications
You must be signed in to change notification settings - Fork 559
docs: edit 1480 #1486
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: edit 1480 #1486
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Greptile Overview
Greptile Summary
This PR provides comprehensive editorial improvements to PR #1480's model-memory-cache documentation.
Key Changes:
- Documentation structure: Moved
model-memory-cachereference fromdocs/user-guides/advanced/index.rsttodocs/index.mdfor better organization within the main documentation table of contents - Improved readability: Enhanced clarity throughout with better sentence structure, consistent terminology, and professional technical writing style
- Better formatting: Added section breaks (
---), subsections ("Without Caching" / "With Caching"), and improved markdown structure - Enhanced clarity: Expanded acronyms (OTEL → OpenTelemetry), clarified technical concepts, and improved explanations of cache behavior
- Removed redundant comments: Cleaned up YAML code blocks by removing inline comments that duplicated section headers
Impact:
The edits significantly improve the documentation quality without changing any technical content or functionality. All markdown formatting is correct, links are valid, and the restructured table of contents properly integrates the new page.
Confidence Score: 5/5
- This PR is completely safe to merge with no risks
- This is a documentation-only PR containing pure editorial improvements with no code changes, no broken links, correct markdown formatting, and proper table of contents reorganization
- No files require special attention
Important Files Changed
File Analysis
| Filename | Score | Overview |
|---|---|---|
| docs/index.md | 5/5 | Added model-memory-cache to the Advanced Uses toctree in the correct alphabetical position |
| docs/user-guides/advanced/index.rst | 5/5 | Removed model-memory-cache entry from this legacy index file as it's now referenced in the main index.md |
| docs/user-guides/advanced/model-memory-cache.md | 5/5 | Comprehensive editorial improvements: improved clarity, formatting, structure with subsections, and professional technical writing style |
Sequence Diagram
sequenceDiagram
participant Dev as Developer
participant PR as PR #1480
participant Editor as Editor/Reviewer
participant Docs as Documentation Site
Dev->>PR: Create PR with model-memory-cache docs
Editor->>PR: Review PR #1480
Editor->>Editor: Identify editorial improvements needed
Editor->>PR: Create PR #1486 with edits
Note over Editor,PR: Editorial Changes
Editor->>Docs: Move toctree entry from index.rst to index.md
Editor->>Docs: Improve clarity & readability
Editor->>Docs: Add section breaks (---)
Editor->>Docs: Add subsections (Without/With Caching)
Editor->>Docs: Expand acronyms (OTEL)
Editor->>Docs: Improve formatting & consistency
PR->>Docs: Merge improves documentation quality
3 files reviewed, no comments
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, thanks for the edits!
3d2bcfc
into
NVIDIA-NeMo:docs/in-memory-model-cache
## Summary Document the memory-caching to reduce latency for frequently Guardrail'ed user requests ## Commit history: * Initial checkin * Completed cache doc, some todos to fill in based on local integration testing * Update example with content-safety, topic-control, and jailbreak nemoguard NIMs * Add memory-caching to the table-of-contents * Cleaned up last TODOs * Apply suggestion from @greptile-apps[bot] Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> Signed-off-by: Miyoung Choi <[email protected]> * edit (#1486) Edits to the memory-cache docs * Final updates to example log format --------- Signed-off-by: Miyoung Choi <[email protected]> Co-authored-by: Miyoung Choi <[email protected]> Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Description
Edits #1480
Related Issue(s)
Checklist