docs(grpc): title-case headings, replace ASCII diagrams with PNGs, archive older version URLs#1420
docs(grpc): title-case headings, replace ASCII diagrams with PNGs, archive older version URLs#1420rgsl888prabhu wants to merge 2 commits into
Conversation
…chive older version URLs - Normalize section titles to title case across all gRPC docs (quick-start, advanced, api, examples, index, grpc-server-architecture) - Replace ASCII art process model and job-states diagrams with PNG images (grpc-process-model.png, grpc-job-states.png) - Increase gRPC toctree maxdepth from 2 to 4 in index.rst - Update versions1.json: older version URLs moved to archive.docs.nvidia.com Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThis PR standardizes CUOpt documentation by updating section heading capitalization to title-case across multiple gRPC documentation files, replacing ASCII diagrams with image references in architecture documentation, and updating documentation metadata and historical version URLs for consistency. ChangesDocumentation Standardization
🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/cuopt/source/versions1.json`:
- Around line 14-42: Update the entry with "version": "25.05" in versions1.json
to use the archived path that returns 200: change the "version" value to
"25.05.00" (or the full version string your switcher expects) and update its
"url" from "https://archive.docs.nvidia.com/cuopt/user-guide/25.05/" to
"https://archive.docs.nvidia.com/cuopt/user-guide/25.05.00/"; ensure the
modified object (the one containing the "version" and "url" keys for 25.05)
matches the format of the surrounding entries so the version switcher resolves
correctly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: adb2a6e4-c042-49dc-969d-a56da790ff2e
⛔ Files ignored due to path filters (2)
docs/cuopt/source/cuopt-grpc/images/grpc-job-states.pngis excluded by!**/*.pngdocs/cuopt/source/cuopt-grpc/images/grpc-process-model.pngis excluded by!**/*.png
📒 Files selected for processing (9)
cpp/docs/grpc-server-architecture.mddocs/cuopt/source/cuopt-grpc/advanced.rstdocs/cuopt/source/cuopt-grpc/api.rstdocs/cuopt/source/cuopt-grpc/examples.rstdocs/cuopt/source/cuopt-grpc/grpc-server-architecture.mddocs/cuopt/source/cuopt-grpc/index.rstdocs/cuopt/source/cuopt-grpc/quick-start.rstdocs/cuopt/source/index.rstdocs/cuopt/source/versions1.json
The 25.05 archived URL returned HTTP 403; the correct path is 25.05.00. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Summary
grpc-server-architecture.mdwith PNG images (grpc-process-model.png,grpc-job-states.png)maxdepthfrom 2 to 4 inindex.rstfor better sidebar navigationversions1.json: older release version URLs moved fromdocs.nvidia.comtoarchive.docs.nvidia.com