Skip to content

docs: correct outdated/inaccurate sections across 4 doc pages - #1668

Merged
SequeI merged 2 commits into
mainfrom
docFixes
Aug 18, 2026
Merged

SequeI merged 2 commits into
mainfrom
docFixes

Conversation

@SequeI

@SequeI SequeI commented Aug 18, 2026

Copy link
Copy Markdown
Member

Summary

  • tool-sandbox.mdx: fix Tool Sandbox mental model — the outer session's exec grant is built from every trusted PATH directory (allow-listing every executable found there), not just the initial program and shims. Verified against crates/nono-cli/src/tool-sandbox/platform/linux.rs and reproduced on a real Landlock host.
  • overview.mdx: update "Resource Exhaustion" — memory and process-count are now enforced on Linux via cgroup v2 (memory.max, pids.max); CPU/disk and macOS remain unenforced. Verified against resource_cgroup.rs and reproduced with --memory/--max-processes triggering real OOM kills and fork EAGAIN.
  • profiles-groups.mdx: fix "Hooks" section — profile-level hooks.<target> installation was removed in v0.44.0 and now only prints a note; actual wiring lives in pack package.json wiring directives. Clarify this is distinct from Session Hooks.
  • profiles-groups.mdx: fix heading nesting — promote "AF_UNIX Socket Grants" and "Working Directory" from h3 to h2 so they're no longer nested under "Session Hooks".

Closes #1630
Closes #1664
Closes #1645
Closes #1644

Verification

All four claims were manually verified, not just read from source:

Test plan

  • Docs-only change — no code touched
  • Manually verified all four corrected claims against actual code/runtime behavior (see above)
  • CI docs build (if any) passes

- tool-sandbox.mdx: fix Tool Sandbox mental model — the outer sessions
  exec grant is built from every trusted PATH directory (allow-listing
  every executable found there), not just the initial program and
  shims. Verified against crates/nono-cli/src/tool-sandbox/platform/linux.rs
  and reproduced on a real Landlock host (#1630).
- overview.mdx: update "Resource Exhaustion" — memory and process-count
  are now enforced on Linux via cgroup v2 (memory.max, pids.max);
  CPU/disk and macOS remain unenforced. Verified against
  resource_cgroup.rs and reproduced with --memory/--max-processes
  triggering real OOM kills and fork EAGAIN (#1664).
- profiles-groups.mdx: fix "Hooks" section — profile-level hooks.<target>
  installation was removed in v0.44.0 and now only prints a note; actual
  wiring lives in pack package.json `wiring` directives. Clarify this
  is distinct from Session Hooks (#1645).
- profiles-groups.mdx: fix heading nesting — promote "AF_UNIX Socket
  Grants" and "Working Directory" from h3 to h2 so theyre no longer
  nested under "Session Hooks" (#1644).

Signed-off-by: Aleksy Siek <aleksy@nolabs.ai>
@github-actions github-actions Bot added documentation Improvements or additions to documentation size/small labels Aug 18, 2026
@github-actions

github-actions Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

PR Review Summary

Size

Metric Value
Lines added +21
Lines removed -23
Total changed 44
Classification Small (< 50 lines)

Affected crates

No crate source directories are directly affected.

Blast radius — Contained

This PR touches: unknown file types


Updated automatically on each push to this PR.

@nogent-nolabs-ai nogent-nolabs-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nogent code review

No issues found; the documentation updates are correct and precisely match the implementation.

Findings: none flagged in scope.

Automated code + security review. CI already covers clippy, rustfmt, tests, cargo-audit and commit-lint.

Signed-off-by: Aleksy Siek <aleksy@nolabs.ai>
@SequeI
SequeI merged commit 1dcbd43 into main Aug 18, 2026
13 checks passed
@SequeI
SequeI deleted the docFixes branch August 26, 2026 15:38
levonk pushed a commit to levonk/nono that referenced this pull request Sep 4, 2026
…-ai#1668)

* docs: correct outdated/inaccurate sections across 4 doc pages

- tool-sandbox.mdx: fix Tool Sandbox mental model — the outer sessions
  exec grant is built from every trusted PATH directory (allow-listing
  every executable found there), not just the initial program and
  shims. Verified against crates/nono-cli/src/tool-sandbox/platform/linux.rs
  and reproduced on a real Landlock host (nolabs-ai#1630).
- overview.mdx: update "Resource Exhaustion" — memory and process-count
  are now enforced on Linux via cgroup v2 (memory.max, pids.max);
  CPU/disk and macOS remain unenforced. Verified against
  resource_cgroup.rs and reproduced with --memory/--max-processes
  triggering real OOM kills and fork EAGAIN (nolabs-ai#1664).
- profiles-groups.mdx: fix "Hooks" section — profile-level hooks.<target>
  installation was removed in v0.44.0 and now only prints a note; actual
  wiring lives in pack package.json `wiring` directives. Clarify this
  is distinct from Session Hooks (nolabs-ai#1645).
- profiles-groups.mdx: fix heading nesting — promote "AF_UNIX Socket
  Grants" and "Working Directory" from h3 to h2 so theyre no longer
  nested under "Session Hooks" (nolabs-ai#1644).

Signed-off-by: Aleksy Siek <aleksy@nolabs.ai>

* fix: rewrite session hook section

Signed-off-by: Aleksy Siek <aleksy@nolabs.ai>

---------

Signed-off-by: Aleksy Siek <aleksy@nolabs.ai>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/small

Projects

None yet

2 participants