Skip to content

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

Closed
rgsl888prabhu wants to merge 4 commits into
mainfrom
release/26.06
Closed

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

Conversation

@rgsl888prabhu

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

Test plan

  • Verify rendered docs show correct title casing in all gRPC sections
  • Confirm PNG diagrams render correctly in grpc-server-architecture page
  • Check sidebar TOC depth shows nested gRPC pages as expected
  • Validate older version links in the version switcher resolve to archive URLs

🤖 Generated with Claude Code

Sylendran95 and others added 4 commits June 4, 2026 13:43
…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>
@rgsl888prabhu rgsl888prabhu requested review from a team as code owners June 10, 2026 16:58
@rgsl888prabhu

Copy link
Copy Markdown
Collaborator Author

Closing in favor of #1420 which uses a proper branch off main.

@coderabbitai

coderabbitai Bot commented Jun 10, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

This PR updates NVIDIA cuOpt documentation to communicate the MIP solver's beta status, GPU-accelerated primal heuristics, and ongoing optimality work, while standardizing gRPC documentation formatting. Additionally, it simplifies dependency version specifiers across conda environments, central manifests, and Python build configs by removing redundant lower-bound qualifiers.

Changes

MIP Solver Beta Documentation Updates

Layer / File(s) Summary
README and core MIP solver documentation
README.md, docs/cuopt/source/cuopt-c/mip/index.rst, docs/cuopt/source/cuopt-cli/index.rst, docs/cuopt/source/cuopt-python/mip/index.rst, docs/cuopt/source/introduction.rst, docs/cuopt/source/milp-features.rst, docs/cuopt/source/mip-settings.rst
Updated README opening description to highlight MIP beta status, supported problem classes, agent-first workflows, and GPU-accelerated primal heuristics. Added consistent beta-status notes across API documentation (C, CLI, Python) and feature pages describing current focus on feasible solution finding and ongoing optimality proof development.
gRPC documentation title-case and structure updates
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
Standardized section heading capitalization to title case across gRPC documentation. Replaced ASCII process-model and job-state diagrams with image references in server architecture documentation.
FAQ entry and documentation version URLs
docs/cuopt/source/faq.rst, docs/cuopt/source/index.rst, docs/cuopt/source/versions1.json
Added new FAQ entry describing MIP solver usage across supported APIs and beta status. Updated documentation table-of-contents maxdepth and standardized gRPC section formatting. Redirected archived documentation version URLs from docs.nvidia.com to archive.docs.nvidia.com.

Dependency Version Qualifier Cleanup

Layer / File(s) Summary
Conda environment dependency simplification
conda/environments/all_cuda-129_arch-aarch64.yaml, conda/environments/all_cuda-129_arch-x86_64.yaml, conda/environments/all_cuda-132_arch-aarch64.yaml, conda/environments/all_cuda-132_arch-x86_64.yaml
Removed redundant >=0.0.0a0 lower-bound qualifiers from cudf, libraft-headers, librmm, pylibraft, rapids-logger, and rmm package pins across four CUDA/architecture variant environment files.
Central dependencies.yaml manifest updates
dependencies.yaml
Simplified package version specifiers across conda and requirement/pyproject matrices by removing >=0.0.0a0 qualifiers from cuOpt, cuOpt-server, cuOpt-sh-client, libcuopt, and RAPIDS package constraints.
Python pyproject.toml dependency specifications
python/cuopt/pyproject.toml, python/cuopt_self_hosted/pyproject.toml, python/cuopt_server/pyproject.toml, python/libcuopt/pyproject.toml
Removed >=0.0.0a0 lower-bound qualifiers from package constraints in project dependencies, optional dependencies, and build backend requires lists.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes


Possibly related PRs

  • NVIDIA/cuopt#596: Updates dependency version pins in the same pyproject.toml and conda environment files affected by this PR's qualifier removal changes.
  • NVIDIA/cuopt#788: Modifies dependencies.yaml and pyproject.toml package version specifiers, intersecting with this PR's dependency pin simplification.

Suggested labels

doc, non-breaking


Suggested reviewers

  • gforsyth
  • tmckayus
  • kaatish
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title directly and concisely summarizes the primary changes: title-casing gRPC headings, replacing ASCII diagrams with PNGs, and archiving older version URLs.
Description check ✅ Passed The description is well-related to the changeset, providing clear context for each category of change (title casing, diagram replacement, toctree depth, version URL updates) and includes a test plan.
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 release/26.06
⚔️ Resolve merge conflicts
  • Resolve merge conflict in branch release/26.06

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

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.

3 participants