Skip to content

docs(grpc): title-case headings, replace ASCII diagrams with PNGs, archive older version URLs#1420

Open
rgsl888prabhu wants to merge 2 commits into
mainfrom
docs/grpc-updates
Open

docs(grpc): title-case headings, replace ASCII diagrams with PNGs, archive older version URLs#1420
rgsl888prabhu wants to merge 2 commits into
mainfrom
docs/grpc-updates

Conversation

@rgsl888prabhu

@rgsl888prabhu rgsl888prabhu commented Jun 10, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Normalize all gRPC documentation section titles to proper title case (quick-start, advanced, api, examples, index, grpc-server-architecture)
  • Replace ASCII art diagrams in grpc-server-architecture.md with PNG images (grpc-process-model.png, grpc-job-states.png)
  • Increase gRPC toctree maxdepth from 2 to 4 in index.rst for better sidebar navigation
  • Update versions1.json: older release version URLs moved from docs.nvidia.com to archive.docs.nvidia.com

…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>
@coderabbitai

coderabbitai Bot commented Jun 10, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: f2981708-5390-403e-b6a8-831700272732

📥 Commits

Reviewing files that changed from the base of the PR and between f982353 and 52c2e5f.

📒 Files selected for processing (1)
  • docs/cuopt/source/versions1.json
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/cuopt/source/versions1.json

📝 Walkthrough

Walkthrough

This 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.

Changes

Documentation Standardization

Layer / File(s) Summary
gRPC documentation heading standardization
cpp/docs/grpc-server-architecture.md, docs/cuopt/source/cuopt-grpc/advanced.rst, docs/cuopt/source/cuopt-grpc/api.rst, docs/cuopt/source/cuopt-grpc/examples.rst, docs/cuopt/source/cuopt-grpc/index.rst, docs/cuopt/source/cuopt-grpc/quick-start.rst
All section headings are updated to use consistent title-case capitalization (e.g., "Quick start" → "Quick Start", "How remote execution works" → "How Remote Execution Works", "Further reading" → "Further Reading"), creating uniform formatting across the gRPC documentation suite.
Architecture documentation diagram replacement
docs/cuopt/source/cuopt-grpc/grpc-server-architecture.md
ASCII/text diagrams for process model and job states are replaced with referenced image assets (images/grpc-process-model.png and images/grpc-job-states.png), reducing document line count while maintaining the same informational content.
Documentation structure and version updates
docs/cuopt/source/index.rst, docs/cuopt/source/versions1.json
Main documentation index toctree maxdepth is increased from 2 to 4 with heading capitalization standardized, and historical version documentation URLs are redirected from the live host to the archive host for versions 26.04.00 through 24.11.

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main changes: title-casing headings, replacing ASCII diagrams with PNGs, and updating archived version URLs.
Description check ✅ Passed The description is clearly related to the changeset, providing specific details about title-casing updates, diagram replacements, toctree depth changes, and URL migrations.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/grpc-updates

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9142298 and f982353.

⛔ Files ignored due to path filters (2)
  • docs/cuopt/source/cuopt-grpc/images/grpc-job-states.png is excluded by !**/*.png
  • docs/cuopt/source/cuopt-grpc/images/grpc-process-model.png is excluded by !**/*.png
📒 Files selected for processing (9)
  • cpp/docs/grpc-server-architecture.md
  • docs/cuopt/source/cuopt-grpc/advanced.rst
  • docs/cuopt/source/cuopt-grpc/api.rst
  • docs/cuopt/source/cuopt-grpc/examples.rst
  • docs/cuopt/source/cuopt-grpc/grpc-server-architecture.md
  • docs/cuopt/source/cuopt-grpc/index.rst
  • docs/cuopt/source/cuopt-grpc/quick-start.rst
  • docs/cuopt/source/index.rst
  • docs/cuopt/source/versions1.json

Comment thread docs/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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants