Skip to content

docs(security): remove internal review pages from public docs - #9062

Merged
cv merged 3 commits into
mainfrom
codex/clean-security-review-pages
Aug 14, 2026
Merged

docs(security): remove internal review pages from public docs#9062
cv merged 3 commits into
mainfrom
codex/clean-security-review-pages

Conversation

@miyoungc

@miyoungc miyoungc commented Aug 13, 2026

Copy link
Copy Markdown
Collaborator

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

  • Move 15 review records from docs/security/ to internal/security-reviews/, delete two obsolete Fern review records and their ledger-only test, and document the public/internal ownership boundary.
  • Remove review pages from Security navigation and public cross-references while preserving supported compatibility guidance on the canonical gateway authentication page.
  • Add direct legacy redirects for extensionless, HTML, index, Markdown, and MDX route forms, with route regression coverage.
  • Update source comments, warnings, and evidence tests to use the canonical public guidance or internal evidence location.
  • Add dependency-upgrade guardrails that keep review evidence out of docs/ and prohibit Fern dependency-review documents or durable Fern review ledgers anywhere in the repository.

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)

Quality Gates

  • Tests added or updated for changed behavior
  • Existing tests cover changed behavior — justification:
  • Tests not applicable — justification:
  • Docs updated for user-facing behavior changes
  • Docs not applicable — justification:
  • Sensitive paths changed (security, policy, credentials, preflight, onboarding, inference, runner, sandbox, or messaging)
  • Sensitive-path review completed or maintainer-approved waiver recorded — reviewer/approval link/justification: Codex Desktop independently reviewed public/internal security ownership, canonical redirects, variant output, and retained compatibility guidance on the final commit.
  • Non-success, skipped, or missing CI check accepted by maintainer — check name, approval link, and follow-up issue:

Documentation Writer Review

  • Documentation writer subagent reviewed the completed changes
  • Result: docs-updated
  • Evidence: Reviewed docs/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.
  • Agent: Codex Desktop

DGX Station Hardware Evidence

  • Tested on DGX Station
  • Tested commit:
  • Station profile/scenario:
  • Result:
  • Supporting evidence:

Verification

  • PR description includes a Signed-off-by: line and every commit appears as Verified in GitHub
  • 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
  • Targeted behavior tests pass for the current change set, or tests are marked not applicable above — command/result or justification: 17 focused Vitest files passed, 197/197 tests; the added Fern no-ledger policy regression passed, with 31 unrelated tests skipped.
  • Applicable broad gate passed — npm test for broad runtime/test-harness changes; npm run check for repo-wide validation/coverage changes — command/result:
  • Quality Gates section completed with required justifications or waivers
  • No secrets, API keys, or credentials committed
  • npm run 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)

npm run docs passed 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

  • Documentation
    • Updated gateway authentication and compatibility guidance with current security information, networking details, and supported environments.
    • Replaced outdated security-review links across changelogs, commands, troubleshooting, and navigation.
    • Added redirects so retired security documentation URLs continue to reach the relevant guidance.
  • Security
    • Separated engineering review evidence from publicly published documentation.
    • Clarified which gateway compatibility behavior is opt-in and documented associated security considerations.
  • Bug Fixes
    • Corrected outdated documentation references and an MCP documentation link.

Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
@miyoungc miyoungc self-assigned this Aug 13, 2026
@copy-pr-bot

copy-pr-bot Bot commented Aug 13, 2026

Copy link
Copy Markdown

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.

@coderabbitai

coderabbitai Bot commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

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: e26cbb1d-e3c6-4175-83b4-20376b5a0cc9

📥 Commits

Reviewing files that changed from the base of the PR and between 6fc834c and 34da83f.

📒 Files selected for processing (52)
  • .agents/skills/nemoclaw-contributor-update-dependencies/SKILL.md
  • Dockerfile
  • Dockerfile.base
  • docs/changelog/2026-06-30.mdx
  • docs/changelog/2026-07-04.mdx
  • docs/changelog/2026-07-06.mdx
  • docs/changelog/2026-07-14.mdx
  • docs/changelog/2026-07-20.mdx
  • docs/changelog/2026-07-22.mdx
  • docs/changelog/2026-08-04.mdx
  • docs/index.yml
  • docs/reference/commands.mdx
  • docs/reference/troubleshooting.mdx
  • docs/security/fern-5.80.1-dependency-review.md
  • docs/security/fern-5.92.4-dependency-review.md
  • docs/security/gateway-authentication-controls.mdx
  • fern/docs.yml
  • internal/security-reviews/README.md
  • internal/security-reviews/e2e-weather-plugin-fixture-dependency-review.md
  • internal/security-reviews/hermes-0.19.0-dependency-review.md
  • internal/security-reviews/managed-base-libssh2-1.11.1-nemoclaw2-dependency-review.md
  • internal/security-reviews/managed-base-perl-5.44-dependency-review.md
  • internal/security-reviews/managed-base-vim-9.2.0858-dependency-review.md
  • internal/security-reviews/openclaw-2026.6.10-dependency-review.md
  • internal/security-reviews/openclaw-2026.7.1-dependency-review.md
  • internal/security-reviews/openshell-0.0.101-migration-review.md
  • internal/security-reviews/openshell-0.0.71-gateway-auth-review.mdx
  • internal/security-reviews/openshell-0.0.72-compatibility-review.mdx
  • internal/security-reviews/openshell-0.0.85-migration-review.md
  • internal/security-reviews/openshell-0.0.99-migration-review.md
  • internal/security-reviews/sandbox-base-2026-07-25-dependency-review.md
  • internal/security-reviews/sandbox-base-2026-07-27-native-package-review.md
  • internal/security-reviews/sandbox-base-libexpat-jq-2026-07-24-dependency-review.md
  • src/lib/onboard/docker-driver-gateway-compat-container.test.ts
  • src/lib/onboard/docker-driver-gateway-compat.ts
  • src/lib/onboard/docker-driver-gateway-config.ts
  • src/lib/onboard/docker-driver-gateway-local-tls.ts
  • test/agent-variant-docs.test.ts
  • test/check-docs-published-routes.test.ts
  • test/dependency-upgrade-skill.test.ts
  • test/e2e-fixture-dependency-review.test.ts
  • test/e2e/support/mcp-bridge-sandbox.test.ts
  • test/fern-dependency-review.test.ts
  • test/hermes-dependency-review.test.ts
  • test/issue-4434-error-fields.test.ts
  • test/openclaw-dependency-review.test.ts
  • test/openclaw-integrity-pin-suite.ts
  • test/openshell-0.0.101-migration-review.test.ts
  • test/openshell-0.0.85-migration-review.test.ts
  • test/openshell-0.0.99-migration-review.test.ts
  • test/perl-critical-cve-remediation.test.ts
  • test/support/openshell-gateway-config-helpers.ts
💤 Files with no reviewable changes (8)
  • docs/security/fern-5.92.4-dependency-review.md
  • test/fern-dependency-review.test.ts
  • docs/changelog/2026-07-20.mdx
  • docs/changelog/2026-07-14.mdx
  • docs/changelog/2026-07-22.mdx
  • docs/changelog/2026-08-04.mdx
  • docs/index.yml
  • docs/security/fern-5.80.1-dependency-review.md

📝 Walkthrough

Walkthrough

The change moves dependency and security review evidence into internal/security-reviews, removes public review links, updates canonical gateway security guidance, adds legacy-route redirects, and expands tests for publication boundaries and contributor policy.

Changes

Security Documentation Boundary

Layer / File(s) Summary
Internal evidence policy and references
.agents/skills/..., internal/security-reviews/*, Dockerfile*, test/*
Defines internal review-record storage, marks review files as non-public, and updates Docker and test references to internal/security-reviews.
Public guidance and legacy redirects
docs/changelog/*, docs/index.yml, docs/security/*, docs/reference/*, fern/docs.yml, src/lib/onboard/*
Replaces review links with canonical security guidance, removes retired navigation entries, documents gateway compatibility controls, and redirects legacy OpenShell routes.
Publication boundary validation
test/check-docs-published-routes.test.ts, test/dependency-upgrade-skill.test.ts, test/openclaw-integrity-pin-suite.ts
Tests unpublished review artifacts, redirect formats and precedence, contributor policy text, and unchanged plugin-version validation behavior.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Mergeability Score: ⚪ Minimal · up to 34da8

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

  • NVIDIA/NemoClaw#8940: Both changes update dependency-review documentation placement and references.

Suggested labels: security

Suggested reviewers: cv, prekshivyas, ericksoa

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: removing internal security review pages from public documentation.
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.
✨ Finishing Touches 💡 2
📝 Generate docstrings 💡
  • Create stacked PR
  • Commit on current branch
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/clean-security-review-pages

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

@github-code-quality

github-code-quality Bot commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

Code Coverage Overview

Languages: TypeScript

TypeScript / code-coverage/plugin

The overall coverage in commit 34da83f in the codex/clean-security... branch remains at 96%, unchanged from commit 6b6b40d in the main branch.

TypeScript / code-coverage/cli

The overall coverage in commit 34da83f in the codex/clean-security... branch remains at 82%, unchanged from commit 6fc834c in the main branch.

Show a code coverage summary of the most impacted files.
File main 6fc834c codex/clean-security... 34da83f +/-
src/lib/onboard...file-builder.ts 95% 91% -4%
src/lib/actions...ild-pipeline.ts 96% 95% -1%
src/lib/actions...light-guards.ts 87% 87% 0%
src/lib/agent/m...fest-readers.ts 96% 96% 0%
src/lib/sandbox...rce-identity.ts 81% 81% 0%
src/lib/agent/defs.ts 95% 97% +2%
src/lib/cua/run...ime-manifest.ts 84% 90% +6%
src/lib/cua/bounded-file.ts 84% 94% +10%

Updated August 14, 2026 00:14 UTC

@github-actions

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

PR Review Advisor — No blocking findings reported

Advisor assessment: No blocking advisor findings reported
Next action: No advisor follow-up needed.
Findings: 0 blockers · 0 warnings · 0 suggestions

Model lanes

  • GPT-5.6 Terra (primary): Completed · medium confidence · 0 blockers · 0 warnings · 0 suggestions
  • Nemotron 3 Ultra (second opinion): Failed after a partial review · low confidence · 0 blockers · 0 warnings · 0 suggestions

Second-opinion terminology and E2E selections are advisory. Live E2E does not run automatically for pull requests.

3 semantic terminology decisions

Terminology decisions are advisory. They affect the assessment only when a separate finding identifies concrete semantic impact.

  • established — Gateway Compatibility Container at docs/security/gateway-authentication-controls.mdx:20: Use Gateway Compatibility Container for the documented fallback and gateway compatibility container in explanatory prose where sentence context identifies the same resource.
  • justified — internal engineering evidence at internal/security-reviews/openclaw-2026.7.1-dependency-review.md:6: Use internal engineering evidence only for maintainer records excluded from public documentation; retain public documentation for supported behavior and procedures.
  • define — durable review ledger at .agents/skills/nemoclaw-contributor-update-dependencies/SKILL.md:77: Define durable review ledger at first use as a retained review record, or replace it with the established term review record.

E2E guidance

Advisory only. A maintainer can dispatch the default E2E suite for the commit under review.

Recommended E2E: None

Manual-only E2E: cloud-onboard, managed-image-multiarch-startup, onboard-repair, onboard-resume, full-e2e
The manual PR workflow does not run these selectors for the commit under review. Run them from reviewed code on main.

Workflow run details

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>
@miyoungc miyoungc added chore Build, CI, dependency, or tooling maintenance area: docs Documentation, examples, guides, or docs build area: skills Skills, agent behaviors, prompts, or skill packaging v0.0.109 labels Aug 14, 2026
@miyoungc
miyoungc marked this pull request as ready for review August 14, 2026 00:05
@cv
cv merged commit 8566aa6 into main Aug 14, 2026
94 of 101 checks passed
@cv
cv deleted the codex/clean-security-review-pages branch August 14, 2026 00:14
cv added a commit that referenced this pull request Aug 14, 2026
<!-- 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>
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 area: skills Skills, agent behaviors, prompts, or skill packaging chore Build, CI, dependency, or tooling maintenance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants