Skip to content

docs: clarify Deep Agents workspace creation timing - #6603

Merged
cv merged 1 commit into
mainfrom
codex/docs-6556-workspace-timing
Jul 9, 2026
Merged

docs: clarify Deep Agents workspace creation timing#6603
cv merged 1 commit into
mainfrom
codex/docs-6556-workspace-timing

Conversation

@miyoungc

@miyoungc miyoungc commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator

Summary

Clarifies that Deep Agents Code creates the documented /sandbox/.deepagents/agent/ paths when the first dcode session starts, not during NemoClaw onboarding.
The page previously listed these paths without distinguishing their creation time from onboarding-created state, which could lead readers to expect them immediately after onboarding.

Related Issue

Closes #6556.

Changes

  • State that /sandbox/.deepagents/agent/ paths do not exist immediately after onboarding.
  • State that Deep Agents Code creates those paths on the first dcode session.

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: prose-only creation-timing clarification; no code sample, generated behavior, or documented command contract changed
  • 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:
  • Non-success, skipped, or missing CI check accepted by maintainer — check name, approval link, and follow-up issue:

Verification

  • PR description includes the DCO sign-off declaration and every commit appears as Verified in GitHub
  • Normal pre-commit, commit-msg, and pre-push hooks passed, or npm run check:diff passed 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: tests are not applicable to this prose-only clarification
  • Applicable broad gate passed — npm test for broad runtime/test-harness changes; npm run check for repo-wide validation/coverage changes — command/result: not applicable to this one-file prose-only docs correction
  • 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) — npm run docs passed with 0 errors and 1 Fern warning
  • Doc pages follow the style guide (doc changes only)
  • New doc pages include SPDX header and frontmatter (new pages only) — not applicable; no new page

Signed-off-by: Miyoung Choi miyoungc@nvidia.com

Summary by CodeRabbit

  • Documentation
    • Clarified when Deep Agents sandbox paths become available during onboarding.
    • Added a note that /sandbox/.deepagents/agent/ is created only after the first dcode session starts.

@miyoungc miyoungc added the area: docs Documentation, examples, guides, or docs build label Jul 9, 2026
@miyoungc miyoungc self-assigned this Jul 9, 2026
@coderabbitai

coderabbitai Bot commented Jul 9, 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: 28902678-ff5d-441b-8102-eea9c88b3e2e

📥 Commits

Reviewing files that changed from the base of the PR and between 614122b and 5af58ce.

📒 Files selected for processing (1)
  • docs/manage-sandboxes/workspace-files.mdx

📝 Walkthrough

Walkthrough

The workspace-files documentation now clarifies that /sandbox/.deepagents/agent/ directories are created when the first dcode session starts, rather than immediately after onboarding.

Changes

Deep Agents documentation

Layer / File(s) Summary
Agent directory creation timing
docs/manage-sandboxes/workspace-files.mdx
Clarifies when /sandbox/.deepagents/agent/ directories become available after onboarding.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the documentation change about Deep Agents workspace creation timing.
Linked Issues check ✅ Passed The documentation update matches issue #6556 by clarifying that agent paths are created on the first dcode session, not at onboarding.
Out of Scope Changes check ✅ Passed The PR appears documentation-only and does not introduce unrelated code or scope beyond the requested clarification.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/docs-6556-workspace-timing

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

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

E2E Advisor Recommendation

Required E2E: None
Optional E2E: None

Workflow run

Full advisor summary

E2E Recommendation Advisor

Base: origin/main
Head: HEAD
Confidence: high

Required E2E

  • None. Docs-only change. The deterministic risk plan has no required jobs, and the edited MDX content cannot affect installer/onboarding, sandbox lifecycle, credentials, security boundaries, network policy, inference routing, deployment, or real assistant user flows at runtime.

Optional E2E

  • None.

New E2E recommendations

  • None.

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

E2E Target Recommendation

Required E2E targets: None
Optional E2E targets: None

Workflow run

Full E2E target advisor summary

E2E Target Advisor

Base: origin/main
Head: HEAD
Confidence: high

Required E2E targets

  • None. Docs-only change outside E2E target-relevant paths; no E2E target dispatch is required.

Optional E2E targets

  • None.

Relevant changed files

  • None.

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

PR Review Advisor — No blocking findings

Merge posture: No blocking advisor findings
Primary next action: Add or justify PRA-T1 and any related test follow-ups.
Open items: 0 required · 0 warnings · 0 suggestions · 1 test follow-up

Action checklist

  • PRA-T1 Add or justify test follow-up: Acceptance clause
Test follow-ups to resolve or justify

If these cover changed behavior, prefer adding them in this PR; otherwise state why existing coverage is enough or link the follow-up.

  • PRA-T1 Acceptance clause — See NVBug for full reproduction steps and environment details. — add test evidence or identify existing coverage. The linked issue body only points to non-public NVBug details; the public, reviewable issue title supplies the actionable docs requirement, which the diff addresses.

Workflow run details

This is an automated, non-binding review; it still expects maintainers and agents to respond to each required or warning item. Treat suggestions as current-PR improvements when they touch changed code; defer only with maintainer rationale or a linked follow-up. A human maintainer must make the final merge decision.

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

PR Review Advisor (Nemotron Ultra) — No blocking findings

Merge posture: No blocking advisor findings
Primary next action: No advisor follow-up required beyond maintainer review.
Open items: 0 required · 0 warnings · 0 suggestions · 0 test follow-ups
Since last review: 0 prior items resolved · 0 still apply · 0 new items found

Workflow run details

This is an automated, non-binding review; it still expects maintainers and agents to respond to each required or warning item. Treat suggestions as current-PR improvements when they touch changed code; defer only with maintainer rationale or a linked follow-up. A human maintainer must make the final merge decision.

@miyoungc

miyoungc commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator Author

PRA-T1 justification: this is a prose-only documentation timing clarification. The public issue title provides the reviewable acceptance clause, and the change does not modify a code sample, generated behavior, or documented command contract, so no targeted runtime test applies. Verification consists of the synchronized Deep Agents variant containing the clarification and npm run docs completing with 0 errors (and the existing single Fern warning reported in the PR body).

@cv
cv enabled auto-merge (squash) July 9, 2026 21:42
@cv
cv merged commit ad518b3 into main Jul 9, 2026
43 of 48 checks passed
@cv
cv deleted the codex/docs-6556-workspace-timing branch July 9, 2026 21:43
Hadar301 pushed a commit to Hadar301/NemoClaw-OpenShift that referenced this pull request Jul 12, 2026
<!-- markdownlint-disable MD041 -->
## Summary
<!-- 1-3 sentences: what this PR does and why. -->

Clarifies that Deep Agents Code creates the documented
`/sandbox/.deepagents/agent/` paths when the first `dcode` session
starts, not during NemoClaw onboarding.
The page previously listed these paths without distinguishing their
creation time from onboarding-created state, which could lead readers to
expect them immediately after onboarding.

## Related Issue
<!-- Fixes #NNN or Closes #NNN. Remove this section if none. -->

Closes NVIDIA#6556.

## Changes
<!-- Bullet list of key changes. -->

- State that `/sandbox/.deepagents/agent/` paths do not exist
immediately after onboarding.
- State that Deep Agents Code creates those paths on the first `dcode`
session.

## Type of Change

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

## Quality Gates
<!-- Check exactly one tests line and one docs line. Check other lines
when applicable. Add every requested justification or approval
reference. -->
- [ ] Tests added or updated for changed behavior
- [ ] Existing tests cover changed behavior — justification:
- [x] Tests not applicable — justification: prose-only creation-timing
clarification; no code sample, generated behavior, or documented command
contract changed
- [x] 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:
- [ ] Non-success, skipped, or missing CI check accepted by maintainer —
check name, approval link, and follow-up issue:

## Verification
<!-- Check each applicable item only when supported by the requested
evidence. Run targeted tests once per relevant change set and rerun
after later edits or hook autofixes that can affect the tested behavior.
Do not rerun hook-covered checks. -->
- [x] PR description includes the DCO sign-off declaration and every
commit appears as `Verified` in GitHub
- [x] Normal `pre-commit`, `commit-msg`, and `pre-push` hooks passed, or
`npm run check:diff` passed 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: tests
are not applicable to this prose-only clarification
- [ ] Applicable broad gate passed — `npm test` for broad
runtime/test-harness changes; `npm run check` for repo-wide
validation/coverage changes — command/result: not applicable to this
one-file prose-only docs correction
- [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) — `npm
run docs` passed with 0 errors and 1 Fern warning
- [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)
— not applicable; no new page

---
<!-- DCO sign-off is required in this PR description, and every commit
must appear as Verified in GitHub. Run: git config user.name && git
config user.email -->
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Clarified when Deep Agents sandbox paths become available during
onboarding.
* Added a note that `/sandbox/.deepagents/agent/` is created only after
the first `dcode` session starts.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[All Platforms][Docs] workspace-files page: agent/ directory paths listed in table are created on first dcode session, not at onboard time

3 participants