Repository navigation
docs: name unknown filesystem keys in the startup notice and archive older notices - #3513
Conversation
…older notices The 2026-10-24 OpenShell Sandbox policy notice said that, apart from a slash-only readOnly path, none of the newly refused settings could deploy an Agent. An unknown policy.filesystem key (a readwrite typo, for example) was ignored and deployed; startup now refuses it. The notice's exception names it. breaking-changes.md was at 2492 of its 2500 words, so the 2026-10-22 and 2026-10-16 notices move to a new before-2026-10-23 page, with the intro link lists on every notice page and a docs.json nav entry. Finding 2345.
|
🦞👀 Pull request received. I will update this pull request when review starts. ClawSweeper review completeClawSweeper finished reviewing this revision. The review result is being finalized. |
|
Codex review: needs maintainer review before merge. What this changesThis PR identifies unknown filesystem keys as an upgrade-breaking setting and moves two older notices into a linked archive page. Example: An Installation contains policy.filesystem.readwrite: ["/data"].
Review scores
ProductKind: Docs · Worth it: Yes · Fix scope: Complete Merge readiness✅ Ready for maintainer review Keep this PR open for maintainer triage: it corrects inaccurate upgrade guidance still present on main, with no actionable findings in the introduced changes. Priority: P3 Before mergeNone. FindingsNone. Agent review detailsHow this fits togetherThe deployment guides help operators interpret Installation validation failures and prepare upgrades; the documentation navigation and archive links expose older notices. flowchart TB
A[Operator planning upgrade] --> B[Breaking changes guide]
B --> C[Current startup notice]
B --> D[Dated archive page]
E[Documentation navigation] --> B
E --> D
Technical reviewBest possible solution: Land the focused notice correction and established archive rotation without changing runtime behavior. Do we have a high-confidence way to reproduce the issue? Source and history establish the documentation error: unknown filesystem keys were ignored before the strict startup schema, while main still says those settings could not deploy. Is this the best way to solve the issue? The patch corrects the existing notice and follows the established date-based archive convention while preserving the moved notice bodies. AGENTS.md: found and applied where relevant. Codex review notes: model internal, reasoning medium; reviewed against 7f966e976c08. Provenance checked
SecurityNone. EvidenceWhat I checked:
Likely related people:
LabelsLabel changes:
Label justifications:
Rating scale6/6 🦀 challenger crab · 5/6 🦞 diamond lobster · 4/6 🐚 platinum hermit · 3/6 🦐 gold shrimp · 2/6 🦪 silver shellfish · 1/6 🧂 unranked krab. Overall follows the weaker of proof and patch quality; ✨ marks media proof (a screenshot, video, or linked artifact) that directly shows the changed behavior. WorkflowClawSweeper edits this one comment on every review. Comment Reviewed October 24, 2026, 4:07 PM ET / 20:07 UTC. |
Problem
The 2026-10-24 notice "OpenShell Sandbox policy settings are checked at startup" (#3499) says that, apart from a slash-only
readOnlypath, none of the newly refused settings could deploy an Agent. That is wrong for an unknownpolicy.filesystemkey. Before #3499,filesystemPolicyread onlyreadOnly,readWriteandincludeWorkdirand ignored every other key. So a typo such as{readOnly: [...], readwrite: [/data]}started and deployed Agents. After the upgrade, the schema'sadditionalProperties: falserefuses that key at startup, which stops a working controller from starting. The notice told that operator they were not affected.Change
policy.filesystemkey such as areadwritetypo, which earlier builds ignored.breaking-changes.mdwas at 2492 of its 2500 words. Following docs: align startup, breaking changes and backend examples with credential proxy #3265's pattern, its 2026-10-22 and 2026-10-16 notices move unchanged to a new page,breaking-changes-before-2026-10-23.md. The intro link list on every notice page now includes the new page, anddocs/docs.jsongets a nav entry for it.Verification
node scripts/docs-site/word-count.mjs: passes.breaking-changes.mdis now 2110 words, and the other notice pages are all under 2420.node scripts/docs-site/build.mjs --check: 291 pages and 4583 links validated.node scripts/check-specs.mjs: passes.node --test tests/docs/docs-length.test.mjs tests/docs/docs-site.test.mjs: 20/20 pass.Risks
Docs only. Bookmarked links to the two moved notices on
breaking-changes.mdnow land at the top of the page, and the intro links to the new page.