Skip to content

docs: name unknown filesystem keys in the startup notice and archive older notices - #3513

Merged
freeqaz merged 1 commit into
mainfrom
fix-docs-2345
Oct 24, 2026
Merged

freeqaz merged 1 commit into
mainfrom
fix-docs-2345

Conversation

@freeqaz

@freeqaz freeqaz commented Oct 24, 2026

Copy link
Copy Markdown
Collaborator

Problem

The 2026-10-24 notice "OpenShell Sandbox policy settings are checked at startup" (#3499) says that, apart from a slash-only readOnly path, none of the newly refused settings could deploy an Agent. That is wrong for an unknown policy.filesystem key. Before #3499, filesystemPolicy read only readOnly, readWrite and includeWorkdir and ignored every other key. So a typo such as {readOnly: [...], readwrite: [/data]} started and deployed Agents. After the upgrade, the schema's additionalProperties: false refuses that key at startup, which stops a working controller from starting. The notice told that operator they were not affected.

Change

  • The notice's "Apart from" exception now also names an unknown policy.filesystem key such as a readwrite typo, which earlier builds ignored.
  • breaking-changes.md was 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, and docs/docs.json gets a nav entry for it.
  • No other page links to an anchor of the moved notices.

Verification

  • node scripts/docs-site/word-count.mjs: passes. breaking-changes.md is 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.md now land at the top of the page, and the intro links to the new page.

…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.
@freeqaz
freeqaz requested a review from a team as a code owner October 24, 2026 19:54
@clawsweeper

clawsweeper Bot commented Oct 24, 2026 •

Copy link
Copy Markdown
Contributor

🦞👀
ClawSweeper picked this up.

Pull request received. I will update this pull request when review starts.

ClawSweeper review complete

ClawSweeper finished reviewing this revision. The review result is being finalized.

View the workflow run.

@clawsweeper clawsweeper Bot added clawsweeper:intake:docs Preliminary submission classification; full source review pending. P3 Low-risk cleanup, docs, polish, ergonomics, or speculative feature. rating: 🐚 platinum hermit Good normal PR readiness with ordinary maintainer review expected. status: 👀 ready for maintainer look ClawSweeper has no concrete contributor-facing blocker left for this PR. and removed clawsweeper:intake:docs Preliminary submission classification; full source review pending. labels Oct 24, 2026
@clawsweeper

clawsweeper Bot commented Oct 24, 2026

Copy link
Copy Markdown
Contributor

Codex review: needs maintainer review before merge.

What this changes

This 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"].

  • Before: The notice incorrectly implies that this Installation could never have deployed an Agent.
  • After: The notice explains that earlier builds ignored the unknown key, so a previously working Installation can fail startup after upgrading.

Review scores

Measure Result What it means
Overall readiness 🐚 platinum hermit (4/6) A focused, source-backed documentation correction with passing exact-head checks and no actionable findings; rendered output was not independently inspected.
Proof confidence 🐚 platinum hermit (4/6) Documentation-only changes were checked against the current schema, predecessor implementation, existing integration scenario, and introduced diff; no runtime proof is required.
Patch quality 🐚 platinum hermit (4/6) No actionable review findings were identified.

Product

Kind: Docs · Worth it: Yes · Fix scope: Complete
User problem: Operators with an ignored filesystem-key typo are incorrectly told that their previously working Installation is outside the upgrade's affected population.
Reason: The collaborator-authored direction fixes a verified documentation error and uses the existing archive convention to stay within the page budget.

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
Reviewed head: cff0cd1e4ce64da9ac1aced73e35d0e8fd8c3f66

Before merge

None.

Findings

None.

Agent review details

How this fits together

The 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
Loading

Technical review

Best 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

  • Startup notice affected population changes intended behavior with a stated reason (4a03195: Move invalid Sandbox policy settings to startup validation and explain the resulting upgrade refusal; the affected-population statement overlooked formerly ignored keys.)
  • Date-based notice archives keeps the original intent (c742f82: Move older notices unchanged into date-based pages so current notices remain within the documentation word limit.)

Security

None.

Evidence

What I checked:

Likely related people:

  • Free Wortley: Raw commit 4a03195 adds docs/guides/deploy/breaking-changes.md:30 relative to its recorded parents. This identifies author metadata, not feature responsibility or a PR merger. (role: source-line author; confidence: high; commits: 4a03195d9f34; files: docs/guides/deploy/breaking-changes.md)

Labels

Label changes:

  • add P3: This is a source-backed documentation correction and archive maintenance with no runtime change.
  • add rating: 🐚 platinum hermit: Overall readiness is 🐚 platinum hermit; proof is 🐚 platinum hermit and patch quality is 🐚 platinum hermit.
  • add status: 👀 ready for maintainer look: ClawSweeper has no concrete contributor-facing blocker left for this PR.

Label justifications:

  • P3: This is a source-backed documentation correction and archive maintenance with no runtime change.
  • rating: 🐚 platinum hermit: Overall readiness is 🐚 platinum hermit; proof is 🐚 platinum hermit and patch quality is 🐚 platinum hermit.
  • status: 👀 ready for maintainer look: ClawSweeper has no concrete contributor-facing blocker left for this PR.

Rating scale

6/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.

Workflow

ClawSweeper edits this one comment on every review. Comment @clawsweeper re-review for a fresh review only. Repair and merge execution lanes are retired.

Reviewed October 24, 2026, 4:07 PM ET / 20:07 UTC.

@freeqaz
freeqaz merged commit 117e3a1 into main Oct 24, 2026
64 checks passed
@freeqaz
freeqaz deleted the fix-docs-2345 branch October 24, 2026 20:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

P3 Low-risk cleanup, docs, polish, ergonomics, or speculative feature. rating: 🐚 platinum hermit Good normal PR readiness with ordinary maintainer review expected. status: 👀 ready for maintainer look ClawSweeper has no concrete contributor-facing blocker left for this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant