Commit 8566aa6
authored
docs(security): remove internal review pages from public docs (#9062)
<!-- markdownlint-disable MD041 -->
## 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)
- [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 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
- [x] 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
<!-- docs-review-head-sha: 34da83f -->
<!-- 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 — 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:
- [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 1 existing Fern warning; the
warning checkbox remains clear because the command was not warning-free.
---
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## 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.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>1 parent 6b6b40d commit 8566aa6
52 files changed
Lines changed: 297 additions & 464 deletions
File tree
- .agents/skills/nemoclaw-contributor-update-dependencies
- docs
- changelog
- reference
- security
- fern
- internal/security-reviews
- src/lib/onboard
- test
- e2e/support
- support
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 10 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
71 | 71 | | |
72 | 72 | | |
73 | 73 | | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
74 | 84 | | |
75 | 85 | | |
76 | 86 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
603 | 603 | | |
604 | 604 | | |
605 | 605 | | |
606 | | - | |
| 606 | + | |
607 | 607 | | |
608 | 608 | | |
609 | 609 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
380 | 380 | | |
381 | 381 | | |
382 | 382 | | |
383 | | - | |
| 383 | + | |
384 | 384 | | |
385 | 385 | | |
386 | 386 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
15 | | - | |
| 15 | + | |
16 | 16 | | |
17 | 17 | | |
18 | 18 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | | - | |
| 12 | + | |
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
11 | | - | |
12 | 11 | | |
13 | 12 | | |
14 | 13 | | |
15 | 14 | | |
16 | 15 | | |
17 | 16 | | |
18 | | - | |
| 17 | + | |
19 | 18 | | |
20 | 19 | | |
21 | 20 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
69 | 69 | | |
70 | 70 | | |
71 | 71 | | |
72 | | - | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
15 | | - | |
16 | 15 | | |
17 | 16 | | |
18 | 17 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
37 | | - | |
38 | 37 | | |
39 | 38 | | |
40 | 39 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
46 | 46 | | |
47 | 47 | | |
48 | 48 | | |
49 | | - | |
50 | 49 | | |
51 | 50 | | |
52 | 51 | | |
| |||
0 commit comments