docs: restructure and polish safety and policy section#189
Merged
Conversation
5 tasks
drew
pushed a commit
that referenced
this pull request
Mar 16, 2026
* restructure safty and policy section * put the table autogeneration back * enhance generate policy ref doc * typo
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reorganize the Safety and Privacy documentation section: remove the redundant security-model page, extract default policy content into its own page, polish the policies page, and add a Sphinx extension that auto-generates policy reference tables from YAML.
Part of #187
Changes
Documentation structure
security-model.md— content was already covered bysafety-and-privacy/index.md; keeping both created redundancy.default-policies.md— new page documenting the built-in default policy, agent compatibility table (Claude Code / OpenCode / Codex), and what the default policy allows.reference/default-policy.md— new reference page that uses thepolicy-tabledirective to render the full default policy from YAML.index.mdto replacesecurity-modelwithdefault-policies.Sphinx extension (
docs/_ext/policy_table.py)policy-table) that reads the sandbox policy YAML (dev-sandbox-policy.yaml) and auto-generates:network_policiesblock with endpoint tables (host, port, TLS, access/rules) and allowed binary lists.docs/conf.py— register the_extdirectory onsys.pathand addpolicy_tableto extensions.Content polish (
policies.md)default-policies.mdpage.Cross-reference fixes (5 files)
security-modelreferences →indexordefault-policiesacrossoverview.md,run-claude.md,run-opencode.md,providers.md, andindex.md.run-claude.mdwhere two Next Steps items both pointed topolicies.md.Test plan
mise run docs:servebuilds without warnings or broken referencespolicy-tabledirective renders tables from the YAML inreference/default-policy.md