Skip to content

docs: split monolithic README into structured docs/ tree #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SoulKyu merged 2 commits into from
Jul 23, 2026
Merged

docs: split monolithic README into structured docs/ tree #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f64105b
docs: split monolithic README into structured docs/ tree
SoulKyu Jul 23, 2026
be66bec
docs: add audit-mode concept guide for the v1.6 milestone
SoulKyu Jul 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .claude/skills/cpg-policy-review/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: >
# cpg-policy-review

Router for an offline policy audit. This skill routes to `cpg explain` and
the `get_evidence` tool for evidence, and points at the README rather than
the `get_evidence` tool for evidence, and points at the docs rather than
restating flag lists or field shapes.

## Step 1: Locate the target
Expand Down Expand Up @@ -44,8 +44,8 @@ For each rule `cpg explain` surfaces, check:
evidence actually shows traffic from? A rule matching a whole namespace
when evidence shows only one workload talking is a candidate to tighten.
- **L7 anchoring:** for HTTP/DNS rules, is the L7 detail (method, path,
matchName) actually present and correctly anchored? See the README's
[L7 Prerequisites](../../../README.md#l7-prerequisites) section for the
matchName) actually present and correctly anchored? See the
[L7 guide](../../../docs/l7-guide.md) for the
capture-time requirements a rule needs before L7 attribution is even
possible — do not re-derive those requirements here, route to it.
- **Missing DNS-53 companions:** an egress rule permitting a `toFQDNs` peer
Expand All @@ -67,7 +67,7 @@ genuinely varied evidence samples justifying the breadth.

Summarize findings per rule: keep as-is, tighten (with the specific narrower
selector/port/L7 filter suggested), or flag as a dedup candidate. Point the
operator at [Explain policies](../../../README.md#explain-policies) in the
README for the full worked examples of `cpg explain` usage if they want to
operator at [Explain & evidence](../../../docs/explain.md)
for the full worked examples of `cpg explain` usage if they want to
reproduce a finding themselves. This skill reports; the operator decides
whether and how to edit the policy YAML.
Loading
Loading