Consolidate sandbox docs into wiki, remove root SANDBOX-PROFILES.md#114
Consolidate sandbox docs into wiki, remove root SANDBOX-PROFILES.md#114
Conversation
57c08a9 to
1306809
Compare
|
Warning Rate limit exceeded
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 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 configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (12)
WalkthroughThis pull request restructures sandbox profile documentation by consolidating and relocating content. The file 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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
📒 Files selected for processing (12)
README.MDSANDBOX-PROFILES.mddocs/mkdocs.ymldocs/src/extra-sandboxing-notes.mddocs/src/sandboxing.mdsrc/reloaded-code-bubblewrap/ARCHITECTURE.mdsrc/reloaded-code-bubblewrap/README.mdsrc/reloaded-code-core/README.mdsrc/reloaded-code-core/src/path/allowed.rssrc/reloaded-code-core/src/tools/bash/mod.rssrc/reloaded-code-serdesai/README.mdsrc/reloaded-code-serdesai/src/tools/bash.rs
💤 Files with no reviewable changes (1)
- SANDBOX-PROFILES.md
…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
7ba899d to
0948b75
Compare
What
Root
SANDBOX-PROFILES.mdwas ~80% redundant with wiki pagedocs/src/sandboxing.md. Both covered profiles, comparison, mount types, isolation, best practices, checklist - but neither was complete alone.Changes
docs/src/extra-sandboxing-notes.md- mount tables, env vars, "why these mounts" rationale, NixOS/Nix roots, cache root explanation,AllowedPathResolversecurity warning, under-the-hood mechanics. Added to wiki nav under Extra.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.SANDBOX-PROFILES.md- all content in wiki now.Result
No duplication. Single source of truth.