Skip to content

docs: clarify docker-driver gateway topology#3662

Closed
WuKongAI-CMU wants to merge 1 commit into
NVIDIA:mainfrom
WuKongAI-CMU:codex/docs-docker-driver-topology
Closed

docs: clarify docker-driver gateway topology#3662
WuKongAI-CMU wants to merge 1 commit into
NVIDIA:mainfrom
WuKongAI-CMU:codex/docs-docker-driver-topology

Conversation

@WuKongAI-CMU

Copy link
Copy Markdown
Contributor

Summary

Clarifies the deployment topology docs now that Linux and Apple Silicon macOS use the OpenShell Docker-driver gateway path by default, while legacy k3s wording only applies to legacy paths such as Windows through WSL2.

Changes

  • Add a platform-to-compute-model table to the architecture reference.
  • Scope memory and Docker storage-driver notes so k3s is only described for legacy gateway paths.
  • Align quickstart and prerequisites wording with the tested Apple Silicon macOS Docker-driver path.
  • Move the Linux newgrp docker recovery command back under the Linux installer guidance.

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with doc updates
  • Doc only (prose changes, no code sample modifications)
  • Doc only (includes code sample changes)

Verification

  • npx prek run --all-files passes
  • npm test passes
  • Tests added or updated for new or changed behavior
  • No secrets, API keys, or credentials committed
  • Docs updated for user-facing behavior changes
  • make docs builds without warnings (doc changes only)
  • Doc pages follow the style guide (doc changes only)
  • New doc pages include SPDX header and frontmatter (new pages only)

Additional focused check: python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user --dry-run.


Signed-off-by: Intern Dev dev@wukongai.io

Signed-off-by: Intern Dev <dev@wukongai.io>
@copy-pr-bot

copy-pr-bot Bot commented May 17, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@coderabbitai

coderabbitai Bot commented May 17, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: a2f64c97-d925-4a67-8078-0000cf049a1a

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@miyoungc

miyoungc commented May 19, 2026

Copy link
Copy Markdown
Collaborator

Docs migration heads-up: #3837 has merged the Fern MDX migration cleanup.

Legacy documentation source pages under docs/**/*.md have been removed, except for docs/CONTRIBUTING.md. Please update this PR so any documentation changes target the matching Fern MDX page under docs/**/*.mdx instead, for example docs/reference/commands.mdx or docs/inference/inference-options.mdx.

CI now validates the MDX sources directly, so deleted legacy Markdown pages should stay deleted.

@wscurran wscurran added area: packaging Packages, images, registries, installers, or distribution platform: container Affects Docker, containerd, Podman, or images area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance and removed area: packaging Packages, images, registries, installers, or distribution Docker labels Jun 3, 2026
@apurvvkumaria apurvvkumaria added the v0.0.79 Release target label Jul 8, 2026
@apurvvkumaria apurvvkumaria self-assigned this Jul 8, 2026
@apurvvkumaria

Copy link
Copy Markdown
Collaborator

Thanks @WuKongAI-CMU for identifying the Docker-driver versus legacy-k3s documentation distinction. The original commit remains attributed to Intern Dev dev@wukongai.io.

Maintainer audit completed against current main at fed4604:

Closing as obsolete/superseded, without merge. No contributor code was copied into a replacement commit, so no new co-author trailer is needed; the original author credit is preserved here in the PR and commit history.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance platform: container Affects Docker, containerd, Podman, or images v0.0.79 Release target

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants