Skip to content

docs: sandbox is the default; mark full-trust samples explicitly - #4

Merged
hamidfzm merged 2 commits into
mainfrom
docs/sandbox-by-default
Jul 20, 2026
Merged

docs: sandbox is the default; mark full-trust samples explicitly#4
hamidfzm merged 2 commits into
mainfrom
docs/sandbox-by-default

Conversation

@hamidfzm

Copy link
Copy Markdown
Member

Glyph is making plugin isolation the default: a manifest without a sandbox flag runs in the sandboxed worker, and only an explicit "sandbox": false opts into full trust, which users must approve through a separate full-access warning (hamidfzm/glyph#434).

  • plugin.schema.json and index.schema.json: document the new default on the sandbox field
  • docs/api-reference.md: rewrite the sandbox section around the new default and the full-trust consent
  • plugins/com.glyph.hello-status and plugins/com.glyph.dictionary-fa: declare "sandbox": false (both use main-context APIs), staging their next releases

Registry entries and published zips are unchanged; the flags ship with each plugin's next release.

Glyph now treats a manifest without a sandbox flag as sandboxed and gates
sandbox:false behind a separate full-access consent (hamidfzm/glyph#434).
Update the schema descriptions and API reference accordingly, and declare
sandbox:false in the hello-status and dictionary-fa manifests, which use
main-context APIs, so their next releases keep working.
The docs tree is the single source for plugin documentation (published at
glyph-md.github.io/plugins), so the remaining pages now state the current
model: the index and recipes describe the sandbox as the default, the
getting-started manifest table explains that false is a user-approved
full-trust opt-out, and the contributing roadmap no longer calls the
sandbox opt-in.
@hamidfzm
hamidfzm merged commit 409d139 into main Jul 20, 2026
1 check passed
@hamidfzm
hamidfzm deleted the docs/sandbox-by-default branch July 20, 2026 23:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant