Skip to content

docs: update Sandbox for standalone praisonai-sandbox package + glob-rule activation#2114

Merged
MervinPraison merged 1 commit into
mainfrom
claude/issue-2106-20260717-1022
Jul 17, 2026
Merged

docs: update Sandbox for standalone praisonai-sandbox package + glob-rule activation#2114
MervinPraison merged 1 commit into
mainfrom
claude/issue-2106-20260717-1022

Conversation

@praisonai-triage-agent

Copy link
Copy Markdown
Contributor

Fixes #2106

Summary

Updates two feature docs to reflect SDK changes shipped in v4.6.151.

Part 1 — docs/features/sandbox-backends.mdx

  • Added a <Note> callout introducing the new standalone praisonai-sandbox package (after the agent-first intro snippet).
  • Rewrote the install table so praisonai-sandbox[...] is the preferred install with legacy praisonai[...] shown as a still-working shim.
  • Updated the fix-it hint and CI install command to the standalone package.
  • Added a "Using the standalone package" section with Tabs (Agent default, direct import, praisonai-sandbox CLI, legacy shim).

Part 2 — docs/features/rules.mdx

  • Added a "How path-scoped rules activate" section leading with an agent example and the on-disk glob rule.
  • Added an activation-mode decision Mermaid (always / glob / manual) with the standard palette.
  • Added the zero-cost gate <Note> and the dedup vs always <Tip>.
  • Existing per-turn sequence diagram, trigger table, and bare-filename matching notes retained.

Constraints honored

  • No files under docs/concepts/ touched.
  • No docs.json changes (both pages already registered).
  • Agent-first code block remains the first snippet on each page.
  • Mermaid diagrams use the standard color scheme with classDef declarations.

Generated with Claude Code

…rule activation (fixes #2106)

Co-authored-by: MervinPraison <454862+MervinPraison@users.noreply.github.com>
@MervinPraison

Copy link
Copy Markdown
Owner

@coderabbitai review

@MervinPraison

Copy link
Copy Markdown
Owner

/review

@qodo-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@MervinPraison

Copy link
Copy Markdown
Owner

@gemini review this PR

@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@MervinPraison, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 36 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7e936503-617d-4f7c-a216-1b0556399250

📥 Commits

Reviewing files that changed from the base of the PR and between e1d67b0 and 08f0672.

📒 Files selected for processing (2)
  • docs/features/rules.mdx
  • docs/features/sandbox-backends.mdx
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/issue-2106-20260717-1022

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.

@MervinPraison MervinPraison added pipeline/awaiting-merge-gate FINAL done; waiting for merge gate / CI pipeline/blocked:ci Blocked: CI not green on HEAD labels Jul 17, 2026

@gemini-code-assist gemini-code-assist 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.

Code Review

This pull request updates the documentation to explain how path-scoped rules activate and introduces the new standalone praisonai-sandbox package. It details how the sandbox backends can be used independently of the full praisonai wrapper, updating installation instructions, CLI commands, and CI pipeline examples. A review comment suggests improving the direct import example for the standalone sandbox package by removing the dependency on praisonaiagents.sandbox.SandboxConfig, which ensures the example remains truly standalone.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment on lines +312 to +316
from praisonai_sandbox import DockerSandbox
from praisonaiagents.sandbox import SandboxConfig

config = SandboxConfig.docker("python:3.11-slim")
sandbox = DockerSandbox(image=config.image, config=config)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

Since the primary purpose of using the standalone praisonai-sandbox package is to run sandboxed environments without pulling in the full praisonai wrapper or its heavy dependencies, importing SandboxConfig from praisonaiagents defeats this goal. We can simplify this direct import example to use DockerSandbox directly with the image argument, keeping it completely standalone.

from praisonai_sandbox import DockerSandbox

sandbox = DockerSandbox(image="python:3.11-slim")

@MervinPraison MervinPraison added pipeline/merge-ready Eligible for merge gate auto-merge and removed pipeline/awaiting-merge-gate FINAL done; waiting for merge gate / CI pipeline/blocked:ci Blocked: CI not green on HEAD labels Jul 17, 2026
@MervinPraison

Copy link
Copy Markdown
Owner

Merge gate scan — eligible for assessment. Claude merge gate will assess and may auto-merge if MERGE_GATE_VERDICT: APPROVE.

@praisonai-triage-agent

Copy link
Copy Markdown
Contributor Author

MERGE_GATE_VERDICT: APPROVE

All checklist items pass:

  • Files: 2 docs in docs/features/ only — no docs/concepts/, docs.json, mint.json, or workflow changes.
  • Labels: pipeline/merge-ready + claude-merge-gate-active — no blocking labels.
  • Size: 133 lines / 2 files — well within docs-primary limits.
  • No secrets in diff.
  • CI: pipeline-sync, CodeRabbit, bot-pr-trigger-reviews, scan-conflicts all pass on HEAD 08f06727.
  • Reviews: No CHANGES_REQUESTED; Gemini left a COMMENTED suggestion (standalone SandboxConfig import) — not a blocking state.
  • Content quality: Both pages add accurate, beginner-friendly content with correct Mintlify components (<Note>, <Tip>, <Tabs>), standard Mermaid colors, and SDK-verified import paths.

@MervinPraison
MervinPraison merged commit 7e66f66 into main Jul 17, 2026
12 checks passed
@MervinPraison

Copy link
Copy Markdown
Owner

Merged by Claude PR merge gate (claude-merge-gate.yml).
Verdict: MERGE_GATE_VERDICT: APPROVE
SHA: 08f0672
Method: merge

@MervinPraison

Copy link
Copy Markdown
Owner

Merge gate scan — not eligible for auto-merge.

  • not open
  • already merged by gate
  • mergeState=UNKNOWN

Actions: wait for CI and the Claude review chain, or add label needs-manual-review and merge manually.
Opt out: label no-auto-merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-merged-by-gate pipeline/merge-ready Eligible for merge gate auto-merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: update Sandbox for new standalone praisonai-sandbox package + document dynamic glob-rule activation

1 participant