Skip to content

Consolidate sandbox docs into wiki, remove root SANDBOX-PROFILES.md#114

Merged
Sewer56 merged 1 commit intomainfrom
move-sandbox-profile-notes
Apr 25, 2026
Merged

Consolidate sandbox docs into wiki, remove root SANDBOX-PROFILES.md#114
Sewer56 merged 1 commit intomainfrom
move-sandbox-profile-notes

Conversation

@Sewer56
Copy link
Copy Markdown
Member

@Sewer56 Sewer56 commented Apr 25, 2026

What

Root SANDBOX-PROFILES.md was ~80% redundant with wiki page docs/src/sandboxing.md. Both covered profiles, comparison, mount types, isolation, best practices, checklist - but neither was complete alone.

Changes

  • New: docs/src/extra-sandboxing-notes.md - mount tables, env vars, "why these mounts" rationale, NixOS/Nix roots, cache root explanation, AllowedPathResolver security warning, under-the-hood mechanics. Added to wiki nav under Extra.
  • Trimmed: docs/src/sandboxing.md - removed duplicate under-the-hood section, replaced with summary + link to extra-sandboxing-notes. Added cross-links under each profile for details.
  • Deleted: root SANDBOX-PROFILES.md - all content in wiki now.
  • Updated 7 stale references across READMEs, ARCHITECTURE.md, and Rust doc comments - now point to published wiki URLs.

Result

Page Purpose
Sandboxing "How do I use this?" - setup, code examples, profile selection, comparison, best practices, checklist
Extra Sandboxing Notes "What does each profile mount and why?" - mount tables, env vars, rationale, under-the-hood

No duplication. Single source of truth.

@Sewer56 Sewer56 force-pushed the move-sandbox-profile-notes branch from 57c08a9 to 1306809 Compare April 25, 2026 14:18
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 25, 2026

Warning

Rate limit exceeded

@Sewer56 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 25 minutes and 51 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 25 minutes and 51 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5f36d634-14c3-47a7-87fe-02b38d03a8e4

📥 Commits

Reviewing files that changed from the base of the PR and between 1306809 and 0948b75.

📒 Files selected for processing (12)
  • README.MD
  • SANDBOX-PROFILES.md
  • docs/mkdocs.yml
  • docs/src/extra-sandboxing-notes.md
  • docs/src/sandboxing.md
  • src/reloaded-code-bubblewrap/ARCHITECTURE.md
  • src/reloaded-code-bubblewrap/README.md
  • src/reloaded-code-core/README.md
  • src/reloaded-code-core/src/path/allowed.rs
  • src/reloaded-code-core/src/tools/bash/mod.rs
  • src/reloaded-code-serdesai/README.md
  • src/reloaded-code-serdesai/src/tools/bash.rs

Walkthrough

This pull request restructures sandbox profile documentation by consolidating and relocating content. The file SANDBOX-PROFILES.md is deleted, and its content is reorganized into a new docs/src/extra-sandboxing-notes.md page within the documentation site. The docs/mkdocs.yml navigation is updated to expose this new page under an "Extra" section. The docs/src/sandboxing.md page is simplified by removing detailed tables and descriptions, instead linking to the new profile reference page. Throughout the codebase, multiple README files and module-level documentation references are updated to point from the old repository file location to the new published documentation URL.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: consolidating sandbox documentation into a wiki and removing the root SANDBOX-PROFILES.md file.
Description check ✅ Passed The description comprehensively covers all key changes with clear sections for what was added, trimmed, deleted, and updated, along with a results table showing the new documentation structure.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch move-sandbox-profile-notes

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🧹 Nitpick comments (1)
docs/src/sandboxing.md (1)

232-233: Consider matching link text to the nav label for easier discovery.

Optional: use “Extra Sandboxing Notes” instead of “Profile Reference” so users can immediately map in-page links to the sidebar entry.

Also applies to: 254-255

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/src/sandboxing.md` around lines 232 - 233, Update the link text "Profile
Reference" to "Extra Sandboxing Notes" in the two occurrences where the inline
link reads [Profile Reference](extra-sandboxing-notes.md#public-bot) so the link
label matches the sidebar nav; search for the exact link string and replace the
bracketed label while keeping the href unchanged to preserve the target (e.g.,
change "[Profile Reference]" to "[Extra Sandboxing Notes]" in the lines
referencing extra-sandboxing-notes.md).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/src/extra-sandboxing-notes.md`:
- Around line 166-167: The markdown link labels `[Nix]` and `[NixOS]` both point
to the same URL; if that's not intentional, update the `[Nix]` reference to the
Nix-specific docs URL (e.g., https://nixos.org/manual/nix/stable/) so `[Nix]`
and `[NixOS]` resolve to distinct, appropriate targets; locate the two link
definitions (`[Nix]` and `[NixOS]`) in docs/src/extra-sandboxing-notes.md and
change the `[Nix]` URL to the Nix manual or another Nix-specific page.

In `@README.MD`:
- Line 152: Replace the local raw docs link for "Sandbox profiles and operator
checklist" with the published docs site URL so it matches other links; locate
the markdown link text "Sandbox profiles and operator checklist" in README.MD
and update its target to the stable site page (the published docs URL) instead
of "docs/src/extra-sandboxing-notes.md".

In `@src/reloaded-code-bubblewrap/ARCHITECTURE.md`:
- Line 6: Update the Markdown link in ARCHITECTURE.md: replace the URL slug
"extra_sandboxing_notes" with the hyphenated "extra-sandboxing-notes" so the
link points to the generated MkDocs route (change the href in the line
containing "Extra Sandboxing Notes" to use extra-sandboxing-notes).

---

Nitpick comments:
In `@docs/src/sandboxing.md`:
- Around line 232-233: Update the link text "Profile Reference" to "Extra
Sandboxing Notes" in the two occurrences where the inline link reads [Profile
Reference](extra-sandboxing-notes.md#public-bot) so the link label matches the
sidebar nav; search for the exact link string and replace the bracketed label
while keeping the href unchanged to preserve the target (e.g., change "[Profile
Reference]" to "[Extra Sandboxing Notes]" in the lines referencing
extra-sandboxing-notes.md).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 49b41b91-cc0e-4004-8c93-91ef71a1fe35

📥 Commits

Reviewing files that changed from the base of the PR and between 6609dec and 1306809.

📒 Files selected for processing (12)
  • README.MD
  • SANDBOX-PROFILES.md
  • docs/mkdocs.yml
  • docs/src/extra-sandboxing-notes.md
  • docs/src/sandboxing.md
  • src/reloaded-code-bubblewrap/ARCHITECTURE.md
  • src/reloaded-code-bubblewrap/README.md
  • src/reloaded-code-core/README.md
  • src/reloaded-code-core/src/path/allowed.rs
  • src/reloaded-code-core/src/tools/bash/mod.rs
  • src/reloaded-code-serdesai/README.md
  • src/reloaded-code-serdesai/src/tools/bash.rs
💤 Files with no reviewable changes (1)
  • SANDBOX-PROFILES.md

Comment thread docs/src/extra-sandboxing-notes.md
Comment thread README.MD Outdated
Comment thread src/reloaded-code-bubblewrap/ARCHITECTURE.md Outdated
…ILES.md

- Move detailed mount tables, env vars, rationale, and AllowedPathResolver
  security note into new docs/src/extra-sandboxing-notes.md
- Trim sandboxing.md: replace duplicate under-the-hood section with links
  to extra-sandboxing-notes.md
- Delete root SANDBOX-PROFILES.md (single source of truth is now the wiki)
- Update all 7 stale SANDBOX-PROFILES.md references across READMEs,
  ARCHITECTURE.md, and Rust doc comments to point to published wiki URLs
- Add Extra Sandboxing Notes to mkdocs.yml nav under Extra section
@Sewer56 Sewer56 force-pushed the move-sandbox-profile-notes branch from 7ba899d to 0948b75 Compare April 25, 2026 14:53
@Sewer56 Sewer56 merged commit 9391138 into main Apr 25, 2026
19 checks passed
@Sewer56 Sewer56 deleted the move-sandbox-profile-notes branch April 25, 2026 14:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant