Skip to content

docs: RFC-005 policy enforcement documentation#30

Merged
beonde merged 1 commit intomainfrom
chore/rfc005-docs
Mar 27, 2026
Merged

docs: RFC-005 policy enforcement documentation#30
beonde merged 1 commit intomainfrom
chore/rfc005-docs

Conversation

@beonde
Copy link
Copy Markdown
Member

@beonde beonde commented Mar 21, 2026

Summary

Adds user-facing documentation for RFC-005 policy enforcement (PDP integration).

Changes

New Pages

  • docs/how-to/security/policy-enforcement.md — Step-by-step guide for configuring PDP integration: observe mode → guard/strict mode, env vars, PDP request/response format, break-glass setup
  • docs/reference/sdk-python/pip.md — PIP types reference (auto-generated via mkdocstrings): PIPRequest, PIPResponse, EnforcementMode, Obligation, attribute types

Updated Pages

  • docs/concepts/enforcement.md — Added §5 "Policy Enforcement" covering PDP integration, enforcement modes, obligations, decision caching, break-glass, badge-only mode
  • docs/reference/grpc.md — Added EvaluatePolicyDecision RPC documentation with full request/response field tables
  • docs/reference/configuration.md — Added "Policy Enforcement (Server)" section with env vars table
  • docs/reference/sdk-python/index.md — Added PIP types to quick import reference and card grid
  • docs/reference/go-api.md — Regenerated with gomarkdoc to include pkg/pip package
  • mkdocs.yml — Added nav entries for new pages

Related

@github-actions
Copy link
Copy Markdown

✅ Documentation Build Successful

The documentation build completed successfully and passed validation checks.

  • ✅ Build completed without errors
  • ✅ Critical files present (index.html, sitemap.xml, robots.txt)
  • ✅ Link validation completed

This PR will deploy to dev-docs.capisc.io when merged to main.

- concepts/enforcement.md: add policy enforcement section (PDP, modes, obligations, caching, break-glass)
- how-to/security/policy-enforcement.md: new setup guide with env vars and PDP request format
- reference/sdk-python/pip.md: new PIP types reference page (auto-generated via mkdocstrings)
- reference/sdk-python/index.md: add PIP types to quick import reference and card grid
- reference/grpc.md: add EvaluatePolicyDecision RPC documentation
- reference/configuration.md: add server-side policy enforcement env vars
- reference/go-api.md: regenerated with pkg/pip package docs
- mkdocs.yml: add new pages to nav
@beonde beonde force-pushed the chore/rfc005-docs branch from a71ce7b to 85ad097 Compare March 27, 2026 18:46
@github-actions
Copy link
Copy Markdown

✅ Documentation Build Successful

The documentation build completed successfully and passed validation checks.

  • ✅ Build completed without errors
  • ✅ Critical files present (index.html, sitemap.xml, robots.txt)
  • ✅ Link validation completed

This PR will deploy to dev-docs.capisc.io when merged to main.

@beonde beonde merged commit 13a4219 into main Mar 27, 2026
4 checks passed
@beonde beonde deleted the chore/rfc005-docs branch March 27, 2026 18:49
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