docs: move Local Development to docs/local-dev.md with disclaimer#734
docs: move Local Development to docs/local-dev.md with disclaimer#734
Conversation
|
All PRs must reference a prior Discord discussion to ensure community alignment before implementation. Please edit the PR description to include a link like: This PR will be automatically closed in 3 days if the link is not added. |
OpenAB PR ScreeningThis is auto-generated by the OpenAB project-screening flow for context collection and reviewer handoff.
Screening report## IntentPR #734 clarifies OpenAB’s deployment security assumptions in the README. It addresses a concrete operator-facing risk: users may assume host-native or non-containerized deployments are appropriate for production, even though OpenAB’s security model expects Kubernetes Pod isolation. FeatDocs improvement. The PR adds a short security disclaimer to the Local Development section of Who It ServesPrimary beneficiary: deployers and agent runtime operators. Secondary beneficiaries: maintainers and reviewers, because the README will better reflect the project’s intended security boundary and reduce repeated clarification around non-K8s deployments. Rewritten PromptUpdate Merge PitchThis is a low-risk documentation change that closes an important expectation gap for operators. It helps prevent unsafe production usage by making the intended isolation model visible where users are likely to read setup instructions. Likely reviewer concern: wording should be precise enough to warn users without implying Kubernetes alone makes arbitrary workloads safe. The disclaimer should frame Kubernetes isolation as part of the supported deployment model, not as a complete security guarantee. Best-Practice ComparisonOpenClaw principles relevant here:
Hermes Agent principles relevant here:
The strongest best-practice alignment is with isolated execution as an explicit documented deployment assumption. This PR does not need to address scheduling, persistence, locking, or retry behavior. Implementation OptionsOption 1: Conservative README disclaimer Option 2: Balanced security note with deployment distinction Option 3: Broader deployment security documentation Comparison Table
RecommendationUse Option 2: add a short security note in the README that clearly separates local development from production deployment expectations. It is still small enough to merge quickly, but more useful than a minimal disclaimer because it names the actual isolation assumptions reviewers care about. A broader security deployment document can be split into a follow-up if maintainers want a fuller production hardening guide. |
d67df05 to
0f2ef0c
Compare
…ges, slash commands)
…enabdev#734) * docs: move Local Development to docs/local-dev.md with security disclaimer * docs: clarify native binaries are for temp dev/debug only * docs: remove Local Development section from README * docs: move Build & Push from README to docs/local-dev.md * docs: remove full reactions config from README (already in config-reference.md) * docs: move Project Structure from README to docs/local-dev.md * docs: add missing features to README (gateway, multi-agent, cron, images, slash commands) --------- Co-authored-by: 超渡法師 <chaodu@openab.dev>
Summary
docs/local-dev.mdContext
Follows the decision to close PR #155 and issue #104 — OpenAB's security model relies on Kubernetes Pod isolation.