docs(security): remove internal review pages from public docs - #9062
Conversation
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
|
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 (52)
💤 Files with no reviewable changes (8)
📝 WalkthroughWalkthroughThe change moves dependency and security review evidence into ChangesSecurity Documentation Boundary
Estimated code review effort: 3 (Moderate) | ~20 minutes Mergeability Score: ⚪ Minimal · up to The PR removes internal review material from public documentation, preserves supported guidance, and adds route and policy coverage; no actionable merge-blocking risk remains after normal checks and review. Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches 💡 2📝 Generate docstrings 💡
🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
Comment |
Code Coverage OverviewLanguages: TypeScript TypeScript / code-coverage/pluginThe overall coverage in commit 34da83f in the TypeScript / code-coverage/cliThe overall coverage in commit 34da83f in the Show a code coverage summary of the most impacted files.
Updated |
|
🌿 Preview your docs: https://nvidia-preview-pr-9062.docs.buildwithfern.com/nemoclaw |
PR Review Advisor — No blocking findings reportedAdvisor assessment: No blocking advisor findings reported Model lanes
Second-opinion terminology and E2E selections are advisory. Live E2E does not run automatically for pull requests. 3 semantic terminology decisionsTerminology decisions are advisory. They affect the assessment only when a separate finding identifies concrete semantic impact.
E2E guidanceAdvisory only. A maintainer can dispatch the default E2E suite for the commit under review. Recommended E2E: None Manual-only E2E: This automated review informs maintainers. Warnings and suggestions do not require a response. A maintainer decides whether to merge. |
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
<!-- markdownlint-disable MD041 --> ## Summary Document the Docker-driver OpenShell gateway authentication boundary that was missing after #9062 moved internal review evidence out of public docs. The public security page now names the host and sandbox authentication paths, token lifetime, fixed settings, and exposure risk. ## Changes - Add supported OpenShell gateway authentication guidance to the canonical gateway security page. - Add a contract test that keeps the public guidance aligned with the generated gateway configuration. ## Type of Change - [ ] Code change (feature, bug fix, or refactor) - [x] Code change with doc updates - [ ] Doc only (prose changes, no code sample modifications) - [ ] Doc only (includes code sample changes) ## Quality Gates - [x] Tests added or updated for changed behavior - [ ] Existing tests cover changed behavior; justification: - [ ] Tests not applicable; justification: - [x] Docs updated for user-facing behavior changes - [ ] Docs not applicable; justification: - [x] Sensitive paths changed (security, policy, credentials, preflight, onboarding, inference, runner, sandbox, or messaging) - [x] Sensitive-path review completed or maintainer-approved waiver recorded; reviewer/approval link/justification: Codex Desktop independently reviewed the authentication claims against the current implementation and found no findings. - [ ] Non-success, skipped, or missing CI check accepted by maintainer; check name, approval link, and follow-up issue: ## Documentation Writer Review - [x] Documentation writer subagent reviewed the completed changes - Result: `docs-updated` - Evidence: Reviewed `docs/security/gateway-authentication-controls.mdx` and `src/lib/onboard/docker-driver-gateway-config-auth-contract.test.ts`. The review covered the writing rules, documentation style, authentication claims, generated guide variants, and documentation contract test. - Agent: Codex Desktop <!-- docs-review-head-sha: 1b7a37b --> <!-- docs-review-agents-blob-sha: e30afb2 --> ## DGX Station Hardware Evidence - [ ] Tested on DGX Station - Tested commit: - Station profile/scenario: - Result: - Supporting evidence: ## Verification - [x] PR description includes a `Signed-off-by:` line and every commit appears as `Verified` in GitHub - [x] Normal `pre-commit`, `commit-msg`, and `pre-push` hooks passed, or `npm run validate:pr` passed after refreshing `origin/main` when hooks were skipped or unavailable - [x] Targeted behavior tests pass for the current change set, or tests are marked not applicable above; `npx vitest run --project cli src/lib/onboard/docker-driver-gateway-config-auth-contract.test.ts`: 5 tests passed. - [ ] Applicable broad gate passed; not run because this change adds one focused documentation contract test and public guidance. - [x] Quality Gates section completed with required justifications or waivers - [x] No secrets, API keys, or credentials committed - [ ] `npm run docs` builds without warnings (doc changes only) - [x] Doc pages follow the [style guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md) (doc changes only) - [ ] New doc pages include SPDX header and frontmatter (new pages only) `npm run docs` passed with 0 errors and 2 existing Fern warnings. All three generated guide variants contain the new guidance. `git diff --check` passed. --- Signed-off-by: Carlos Villela <cvillela@nvidia.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added guidance for gateway authentication, including host and sandbox authentication paths. * Documented local TLS/mTLS, sandbox JWT defaults, non-expiring local JWTs, configuration constraints, security considerations, and loopback binding recommendations. * **Tests** * Added coverage to verify that public authentication guidance includes required security settings and recommendations. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Signed-off-by: Carlos Villela <cvillela@nvidia.com>
Summary
Remove point-in-time dependency and migration review artifacts from the public Security documentation, preserve the remaining maintainer evidence internally, and delete obsolete Fern review ledgers. Former public routes now redirect to canonical gateway authentication guidance, and the dependency-upgrade workflow prevents internal review evidence from returning to
docs/.Changes
docs/security/tointernal/security-reviews/, delete two obsolete Fern review records and their ledger-only test, and document the public/internal ownership boundary.docs/and prohibit Fern dependency-review documents or durable Fern review ledgers anywhere in the repository.Type of Change
Quality Gates
Documentation Writer Review
docs-updateddocs/security/gateway-authentication-controls.mdx,docs/index.yml,docs/reference/commands.mdx,docs/reference/troubleshooting.mdx, changed changelog entries,fern/docs.yml,internal/security-reviews/, the Fern review-record deletions and no-ledger policy, and.agents/skills/nemoclaw-contributor-update-dependencies/SKILL.md; writing rules and documentation style were reviewed.DGX Station Hardware Evidence
Verification
Signed-off-by:line and every commit appears asVerifiedin GitHubpre-commit,commit-msg, andpre-pushhooks passed, ornpm run validate:prpassed after refreshingorigin/mainwhen hooks were skipped or unavailablenpm testfor broad runtime/test-harness changes;npm run checkfor repo-wide validation/coverage changes — command/result:npm run docsbuilds without warnings (doc changes only)npm run docspassed with 0 errors and 1 existing Fern warning; the warning checkbox remains clear because the command was not warning-free.Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit