Skip to content

docs: reflect Cedar shipped alongside Rego as a peer backend#87

Merged
boorad merged 1 commit into
mainfrom
chore/docs-rego-cedar-targets
May 15, 2026
Merged

docs: reflect Cedar shipped alongside Rego as a peer backend#87
boorad merged 1 commit into
mainfrom
chore/docs-rego-cedar-targets

Conversation

@boorad
Copy link
Copy Markdown
Contributor

@boorad boorad commented May 15, 2026

Summary

User-facing docs still framed PaC generation as Rego-only with Cedar "on the roadmap," but Cedar landed in v0.2 as a peer backend — src/cedar/ (generator, grouping, templates, validator via cedar-policy), extract --engine cedar, and engine-agnostic MCP tools (suggest_policy / validate_policy) are all live. This PR sweeps the stale "Rego today" / "OPA today" phrasings out of the README, AGENTS.md, Cargo.toml, and DESIGN.md, and flips the CEDAR_SUPPORT.md memo from "Draft — exploring for v0.3" to "Historical — shipped in v0.2".

Changes

  • README.md — tagline, intro, extract CLI example, MCP framing; tools table now lists suggest_policy / validate_policy with suggest_rego / validate_rego called out as backward-compat aliases; dropped stale "seven tool descriptors" count
  • AGENTS.md (CLAUDE.md symlink) — opening tagline; rules description now references both rego_template and cedar_template; split the engine module bullet into separate Rego and Cedar entries
  • Cargo.toml — crate description field
  • docs/DESIGN.md — vision, goals, pattern-rule template list, policy-generation section, EXTRACT CLI options (added --engine, renamed --package-prefix--policy-prefix with the alias documented), EnforceAuth relationship section
  • docs/CEDAR_SUPPORT.md — status banner flipped to "Historical — shipped in v0.2"; body preserved as the original scoping snapshot so the design narrative isn't lost

Each touched spot now names the AWS Verified Permissions / Arbiter / Cedar-compatible audience explicitly.

Test plan

  • cargo build — sanity check that the Cargo.toml description edit parses
  • Render README / DESIGN.md / CEDAR_SUPPORT.md on GitHub and skim for broken markdown or stale phrasing
  • Confirm cargo publish --dry-run (if used in release-plz) accepts the new description string
  • Visual diff review — pure docs change, no runtime impact

Follow-ups (filed separately)

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated documentation to reflect policy generation support for both Rego (OPA) and Cedar (AWS Verified Permissions and other Cedar-compatible engines).
    • Clarified CLI options including --engine parameter for selecting policy backends.
    • Updated MCP tool descriptions with engine-agnostic naming conventions.
    • Marked Cedar support as shipped in v0.2.

Review Change Stack

The README, AGENTS.md, DESIGN.md, Cargo.toml description, and the Cedar
scoping memo all framed PaC generation as Rego-only with Cedar on the
roadmap. Cedar landed in v0.2 (src/cedar/ generator + cedar-policy
validator, extract --engine cedar, engine-agnostic MCP suggest_policy /
validate_policy tools), so the docs now name Rego for OPA and Cedar for
AWS Verified Permissions, Arbiter, and other Cedar-compatible engines.
The CEDAR_SUPPORT.md status banner is flipped from "Draft - exploring
for v0.3" to "Historical - shipped in v0.2" with the body preserved as
the original scoping snapshot.
@boorad boorad self-assigned this May 15, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 15, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 2dd3c72a-b49f-4557-abb8-f55a7f538e81

📥 Commits

Reviewing files that changed from the base of the PR and between 2863701 and 21085c8.

📒 Files selected for processing (5)
  • AGENTS.md
  • Cargo.toml
  • README.md
  • docs/CEDAR_SUPPORT.md
  • docs/DESIGN.md

📝 Walkthrough

Walkthrough

Documentation updates across package metadata, README, design documentation, and agent specifications to reflect that Zift generates Policy-as-Code for both Rego (OPA) and Cedar (AWS Verified Permissions and Cedar-compatible engines), with clarified CLI engine selection and Cedar recorded as shipped in v0.2.

Changes

Multi-engine scope and interface documentation

Layer / File(s) Summary
Feature overview and scope documentation
Cargo.toml, AGENTS.md, docs/DESIGN.md, README.md
Opening descriptions, package metadata, architecture notes, and Goals updated to explicitly state that Zift generates Policy-as-Code for both Rego (OPA) and Cedar (AWS Verified Permissions, Arbiter, and other Cedar-compatible engines).
CLI and MCP tool interface updates
README.md, docs/DESIGN.md
extract command expanded with --engine (rego|cedar), --policy-prefix, and --output-dir options; MCP tools broadened from Rego-only suggest_rego/validate_rego to engine-agnostic suggest_policy/validate_policy with backward-compatible Rego aliases.
Policy template and shipped status updates
docs/CEDAR_SUPPORT.md, docs/DESIGN.md, README.md
Pattern rule documentation now describes per-engine policy templates (Rego and Cedar); Cedar support status marked Historical with v0.2 shipped details; MCP smoke-test reference generalized to remove hardcoded tool count.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • EnforceAuth/zift#28: Continues the policy-as-code and Cedar backend documentation refactor by recording Cedar as shipped (v0.2) and further broadening design and MCP interface documentation to reflect active multi-engine support.

Poem

🐰 Cedar trees grow tall and proud,
Rego rules march through the cloud,
One extraction, engines two—
Policy templates see them through!
Authorization's brave new ✨ crew!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main objective of the PR: updating documentation to show Cedar as a peer backend alongside Rego, which is confirmed by changes across README.md, DESIGN.md, CEDAR_SUPPORT.md, AGENTS.md, and Cargo.toml.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/docs-rego-cedar-targets

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@amazon-q-developer amazon-q-developer Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This documentation PR accurately updates all references to reflect Cedar's shipped status in v0.2. The changes consistently sweep "Rego today" / "on the roadmap" phrasings across README, AGENTS.md, Cargo.toml, DESIGN.md, and flip CEDAR_SUPPORT.md to historical status. All updates align with the actual codebase state where src/cedar/, extract --engine cedar, and engine-agnostic MCP tools are live.

No defects blocking merge identified.


You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.

@boorad boorad merged commit 706a545 into main May 15, 2026
3 checks passed
@boorad boorad deleted the chore/docs-rego-cedar-targets branch May 15, 2026 04:03
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